Centrobill Payment API (1.1.31)

Download OpenAPI specification:Download

Centrobill API

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: Authorization

Payment

Generate card data token

header Parameters
X-Request-ID
any

Unique ID of request

Request Body schema: application/json
number
required
string (Card number) [ 12 .. 19 ] characters
expirationYear
required
string (Card expiration year) 2 characters
expirationMonth
required
string (Card expiration month) 2 characters
cvv
string (Card secure code) [ 3 .. 4 ] characters
cardHolder
string (Cardholder full name) [ 1 .. 64 ] characters
zip
string (Consumer's zip) [ 1 .. 16 ] characters

Responses

Request samples

Content type
application/json
{
  • "number": "4024007179366348",
  • "expirationYear": "25",
  • "expirationMonth": "12",
  • "cvv": "009",
  • "cardHolder": "John Smith",
  • "zip": "14000"
}

Response samples

Content type
application/json
{
  • "token": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
  • "expireAt": 1611735028
}

Pay

Authorizations:
header Parameters
X-Request-ID
any

Unique ID of request

Request Body schema: application/json
required
Credit card (object) or Sepa (object) or Soforbanking (object) or Onlinebanking (object) or Paysafecard (object) or Giropay (object) or Ideal (object) or Przelewy24 (object) or Bancontact (object) or Eps (object) or Mybank (object) or Using consumer's account details (object) or Using concrete payment account of customer (object) or Token (object)
required
SKU object with site id (object) or SKU object with with SKU name (object) or SKU object with with SKU name and custom prices (object)
required
object (Consumer object)
object (url)
metadata
object (metadata)

Used for storing additional structured information associated with payment

Responses

Callbacks

Request samples

Content type
application/json
{
  • "paymentSource":
    {
    },
  • "sku":
    {
    },
  • "consumer":
    {
    },
  • "metadata":
    {
    }
}

Response samples

Content type
application/json
{
  • "payment":
    {
    },
  • "consumer":
    {
    },
  • "subscription":
    {
    },
  • "metadata":
    {
    }
}

Callback payload samples

Callback
POST: Payment status callback
Content type
application/json
{
  • "payment":
    {
    },
  • "consumer":
    {
    },
  • "subscription":
    {
    },
  • "metadata":
    {
    }
}

Credit

Authorizations:
path Parameters
id
required
any

Transaction that should be credited

header Parameters
X-Request-ID
any

Unique ID of request

Request Body schema: application/json
amount
required
number <double> (Amount of operation)
reason
required
string (Reason of operation) [ 3 .. 64 ] characters

Responses

Request samples

Content type
application/json
{
  • "amount": 9.99,
  • "reason": "Retention offer"
}

Response samples

Content type
application/json
{
  • "payment":
    {
    }
}

Payout

Payout

Authorizations:
header Parameters
X-Request-ID
any

Unique ID of request

Request Body schema: application/json
consumerId
required
string [ 5 .. 36 ] characters
paymentAccountId
string <uuid>
parameters
object

List of additional payout parameters

amount
required
number <double> (Amount of operation)
currency
required
string <iso3> (Currency)
object
metadata
object (metadata)

Used for storing additional structured information associated with payment

Responses