Last 7 days, UTC

Average Latency
188ms

Average Uptime
100.0%

Current Status
Online

  • No information
  • Outage
  • Disruption
  • Normal
Average latency determined from Mashape to API Response time
Basic Authentication
 

Enter your private key from www.paymill.com as user name and leave password field empty


Authentication
Description
Parameter
String

HTTP basic username

Username

Required

String

HTTP basic password

Password

Client

HTTP 200 : string GET/clients/{id}
client details

To get the details of an existing client you’ll need to supply the client ID. The client ID is returned by creating a client.


Test console
Description
Parameter
string

Unique identifier for the client

id

Required

HTTP 200 : string POST/clients
create new client

This function creates a client object.


Test console
Description
Parameter
string

Mail address of the client, is optional if the transaction creates an user itself

email

Optional

string

Description for the client

description

Optional

HTTP 200 : string GET/clients/
export client list

This function returns CSV seperated by semicolons, encapsulated by double quotes, with a list of clients. The following parameters can be used:


Test console
Description
Parameter
string

count

count

Optional

string

offset

offset

Optional

string

creditcard

creditcard

Optional

string

email

email

Optional

string

created_at

created_at

Optional

HTTP 200 : string GET/clients
list clients

Test console
Description
Parameter
string

count

count

Optional

string

offset

offset

Optional

string

creditcard

creditcard

Optional

string

email

email

Optional

string

created_at

created_at

Optional

HTTP 200 : string DELETE/clients/{id}
remove client

This function deletes a client, but your transactions aren’t deleted.


Test console
Description
Parameter
string

Unique identifier for the client

id

Required

HTTP 200 : string PUT/clients/{id}
update client

This function updates the data of a client. To change only a specific attribute you can set this attribute in the update request. All other attributes that shouldn’t be edited aren’t inserted. You can only edit the description, email and credit card. The subscription can’t be changed by updating the client data. This has to be done in the subscription call.


Test console
Description
Parameter
string

Unique identifier for the client

id

Required

string

mail address of the client.

email

Optional

string

Description for the client

description

Optional

Offer

HTTP 200 : string POST/offers
create new offer

With this call you can create an offer via the API. You can also create an offer with the merchant cockpit.


Test console
Description
Parameter
string

Amount (in cents)

amount

Optional

string

ISO 4217 formatted currency code

currency

Optional

string

Defining how often the client should be charged. Format: number DAY|WEEK|MONTH|YEAR Example: 2 DAY

interval

Optional

string

Your name for this offer

name

Optional

HTTP 200 : string GET/
list offers

This function returns a JSON object with a list of offers. In which order this list are returned depends on the optional parameter order. The following parameters can be used:


Test console
Description
Parameter
string

count

count

Optional

string

offset

offset

Optional

string

interval

interval

Optional

string

amount

amount

Optional

string

created_at

created_at

Optional

string

trial_period_days

trial_period_days

Optional

HTTP 200 : string GET/offers/{id}
offer details

Getting detailed information about an offer requested with the offer ID.


Test console
Description
Parameter
string

Unique identifier for the offer

id

Required

HTTP 200 : string DELETE/offers/{id}
remove offer

You only can delete an offer if no client is subscribed to this offer


Test console
Description
Parameter
string

Unique identifier for the offer

id

Required

HTTP 200 : string PUT/offers/{id}
update offer

Updates the offer. Only the name can be changed all other attributes cannot be edited.


Test console
Description
Parameter
string

Unique identifier for the offer

id

Required

string

Your name for this offer

name

Optional

Payments

HTTP 200 : string POST/payments
create payment with token or client

Creates a credit card payment from a given token, if you’re providing the client-property, the payment will be created and subsequently be added to the client.


Test console
Description
Parameter
string

Unique credit or debit card token

token

Optional

string

Unique client identifier
Example: client_88a388d9dd48f86c3136

client

Optional

HTTP 200 : string GET/payments
list payments

Returns a list of all payment objects.


HTTP 200 : string GET/payments/{id}
payment details

Returns data of a specific payment.


Test console
Description
Parameter
string

id

Required

HTTP 200 : string DELETE/payments/{id}
remove payment

Test console
Description
Parameter
string

Unique identifier for the payment

id

Required

Preauthorizations

HTTP 200 : string POST/preauthorizations
create preauthorization

Use either a token or an existing payment to authorize the given amount.


Test console
Description
Parameter
number

Amount (in cents) which will be charged

amount

Required

string

ISO 4217 formatted currency code

currency

Required

string

The identifier of a token

token

Optional

string

The identifier of a payment

payment

Optional

HTTP 200 : string GET/preauthorizations
list preauthorizations

This function returns a JSON object with a list of preauthorizations. In which order this list is returned depends on the optional parameter order: count, offset, created_at


HTTP 200 : string GET/preauthorizations/{id}
preauthorization details

Returns data of a specific preauthorization


Test console
Description
Parameter
string

Unique identifier of this preauthorization

id

Required

HTTP 200 : string DELETE/preauthorizations/{id}
remove preauthorizations

This function deletes a preauthorization.


Test console
Description
Parameter
string

Unique identifier for the preauthorization

id

Required

Refunds

HTTP 200 : string GET/refunds/
list refunds

This function returns a list of existing transactions. In which order this list is returned depends on the optional parameter order. The following parameters can be used:


Test console
Description
Parameter
string

count

count

Optional

string

offset

offset

Optional

string

transaction

transaction

Optional

string

client

client

Optional

string

amount

amount

Optional

string

created_at

created_at

Optional

HTTP 200 : string GET/refunds/{id}
refund details

Returns detailed informations of a specific refund.


Test console
Description
Parameter
string

refund id

id

Required

HTTP 200 : string POST/refunds/
refund transaction

This function refunds a transaction that has been created previously and was refunded in parts or wasn’t refunded at all. The inserted amount will be refunded to the credit card / direct debit of the original transaction. There will be some fees for the merchant for every refund.


Test console
Description
Parameter
number

Amount (in cents) which will be charged

amount

Required

string

additional description for this refund

description

Optional

Subscription

HTTP 200 : string POST/subscriptions
create new subscription

This function creates a subscription between a client and an offer. A client can have several subscriptions to different offers, but only one subscription to the same offer. The clients is charged for each billing interval entered.


Test console
Description
Parameter
string

Unique client identifier

client

Required

string

Unique offer identifier

offer

Required

string

Unique payment identifier

payment

Required

HTTP 200 : string GET/subscriptions
list subscriptions

This function returns a JSON object with a list of subscriptions. In which order this list is returned depends on the optional parameter order. The following parameters can be used:


Test console
Description
Parameter
string

count

count

Optional

string

offset

offset

Optional

string

offer

offer

Optional

string

canceled_at

canceled_at

Optional

string

created_at

created_at

Optional

HTTP 200 : string DELETE/subscriptions/{id}
remove subscription

This function removes an existing subscription. If you set the attribute cancel_at_period_end parameter to the value true, the subscription will remain active until the end of the period. The subscription will not be renewed again. If the value is set to false it is directly terminated but pending transactions will still be charged.


Test console
Description
Parameter
string

Unique identifier for the subscription

id

Required

HTTP 200 : string GET/subscriptions/{id}
subscription details

Test console
Description
Parameter
string

Unique identifier for the subscription

id

Required

HTTP 200 : string PUT/subscriptions/{id}
update subscription

This function updates the subscription of a client. You can change e.g. the cancel_at_period_end attribute to terminate a subscription at a special point of time. Or you can assign another offer subscription (offer=<new_offer_id>).


Test console
Description
Parameter
string

Unique identifier for the subscription

id

Required

boolean

Cancel this subscription immediately or at the end of the current period?

cancel_at_period_end

Optional

string

Unique identifier describing the offer which is subscribed to the client

offer

Optional

string

Unique identifier describing a payment of the client

payment

Optional

Transactions

HTTP 200 : string POST/transactions
create transaction

You have to create at least either a token or a payment object before you can execute a transaction. You get back a response object indicating whether a transaction was successful or not. Note The transaction will not be charged at the bank if the test keys are implemented in your code. Please use only the test credit cards mentioned in the documentation.


Test console
Description
Parameter
number

Amount (in cents) which will be charged

amount

Required

string

ISO 4217 formatted currency code

currency

Required

string

A short description for the transaction

description

Required

string

The identifier of a client (client-object) When this parameter is used, you have also to specify a payment method which is not assigned to a client yet. If you attempt to use this parameter when creating a transaction and when specifying a token or preauthorization, the specified client will be ignored.

client

Optional

string

A token generated through our JavaScript-Bridge When this parameter is used, none of the following should be used: payment, preauthorization.

token

Optional

string

The identifier of a payment (creditcard-object or directdebit-object) When this parameter is used, none of the following should be used: token, preauthorization.

payment

Optional

string

The identifier of a preauthorization (preauthorization-object) When this parameter is used, none of the following should be used: token, payment.

preauthorization

Optional

HTTP 200 : string GET/transactions
list transactions

This function returns a JSON object with a list of transactions. In which order this list is returned depends on the optional parameter order: count ,offset, created_at


HTTP 200 : string GET/transactions/{id}
transaction details

To receive the details of an existing transaction, call the unique transaction ID. You can find the ID in the response of the previous request. The return is a refund object with the information of the used payment, client and transaction attributes.


Test console
Description
Parameter
string

Unique identifier of this transaction

id

Required

Webhook

HTTP 200 : string POST/webhooks
create new URL or EMAIL webhook

With this call you can create a webhook to a url via the API.


Test console
Description
Parameter
string

the url of the webhook

url

Optional

string

includes a set of webhook event types as strings
Example: subscription.succeeded,subscription.failed

event_types

Optional

string

the webhooks email. must be a valid mail address

email

Optional

HTTP 200 : string GET/webhooks/
list webhooks

This function returns a JSON object with a list of webhooks. In which order this list is returned depends on the optional parameter order. The following parameters can be used:


Test console
Description
Parameter
string

count

count

Optional

string

offset

offset

Optional

string

url

url

Optional

string

email

email

Optional

string

created_at

created_at

Optional

string

order

order

Optional

HTTP 200 : string DELETE/webhooks/{id}
remove webhook

All pending calls to a webhook are deleted as well, as soon as you delete the webhook itself.


Test console
Description
Parameter
string

webhook id

id

Required

HTTP 200 : string PUT/webhooks/{id}
update webhook

Updates the webhook. You can change the url/email and the event types.


Test console
Description
Parameter
string

the url of the webhook

url

Optional

string

the email for the webhook

email

Optional

string

array of event_types

event_types

Optional

string

webhook id

id

Required

HTTP 200 : string GET/webhooks/{id}
webhook details

Getting detailed information about a webhook requested with the webhook id.


Test console
Description
Parameter
string

requested with the webhook id.

id

Required

Consume this API completely for free!


By joining the mashape API marketplace you can start using PAYMILL GmbH API today!

Login to your account or signup: Create Account

or
   Signup with GitHub

By signing up you agree to our terms of service.