Centrobill Payment API (1.8.1)

Download OpenAPI specification:Download

Centrobill API

The HTTP headers are used to pass additional information between the clients and the server through the request and response header. Certain request customization requires setting HTTP headers. Content-Type and Accept headers control input and output format.

Authentication

ApiKeyAuth

Security Scheme Type	API Key
Header parameter name:	Authorization

Payment

Tokenization

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

number required	string (schemas) [ 12 .. 19 ] characters Full card number
expirationYear required	string (schemas) 2 characters The expiry year of the card
expirationMonth required	string (schemas) 2 characters The expiry month of the card
cvv	string (schemas) [ 3 .. 4 ] characters The final three digits printed on the back of the card
cardHolder	string (schemas) [ 1 .. 64 ] characters The cardholder full name
zip	string (schemas) [ 1 .. 16 ] characters Postal code

Responses

Request samples

Payload

Content type

application/json

{"number": "4024007179366348",
"expirationYear": "25",
"expirationMonth": "12",
"cvv": "009",
"cardHolder": "John Smith",
"zip": "14000"
}

Response samples

201
400
401
403
500

Content type

application/json

{"token": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
"expireAt": 1611735028
}

Tokenization using payment account & consumer IDs

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

paymentAccountId required	string <uuid> ID of the encoded user payment details
consumerId required	string [ 5 .. 36 ] characters Gateway consumer ID (user ID)
cvv required	string (schemas) [ 3 .. 4 ] characters The final three digits printed on the back of the card

Responses

Request samples

Payload

Content type

application/json

{"paymentAccount": "03a470ee-6fb8-4e46-8d7c-b47f345cd09a",
"consumerId": "12345678",
"cvv": "009"
}

Response samples

201
400
401
403
500

Content type

application/json

{"token": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
"expireAt": 1611735028
}

Server-to-server

Authorizations:

ApiKeyAuth

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

required	Credit card (object) or Sepa (object) or Sofortbanking (object) or Onlinebanking (object) or Paysafecard (object) or Giropay (object) or Ideal (object) or PPS (object) or Gash (object) or Przelewy24 (object) or Bancontact (object) or Eps (object) or Mybank (object) or Consumer saved payment data (object) or Concrete payment account of customer with CVV number (object) or Concrete payment account of customer (object) or Token of tokenized card data (object) or Crypto (object) or X1 (object) or PayID (object) or ACH (object) or Apple pay (object) or PIX (object)
required	SKU object with site ID (object) or SKU object with SKU name (object) or SKU object with SKU name and custom prices (object)
required	object
required	object
metadata	object (schemas) Use to store additional structured information associated with payment. For example, to tie transactions to the orders in your system
	object (schemas)

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"paymentSource": {"type": "card",
"number": "4024007179366348",
"expirationMonth": "11",
"expirationYear": "22",
"cvv": "100",
"3ds": false
},
"sku": {"title": "Product name",
"siteId": "983759353",
"price": [{"offset": "0d",
"amount": 19.99,
"currency": "USD",
"repeat": false
}
]
},
"consumer": {"id": "4242522",
"email": "jonny.sonny@google.com",
"firstName": "John",
"lastName": "Doe",
"phone": "+1987353539",
"country": "USA",
"state": "Alabama",
"city": "Montgomery",
"zip": "36101",
"ip": "8.8.8.8",
"userAgent": "mozilla/5.0 (iphone; cpu iphone os 13_1_2 like mac os x) applewebkit/605.1.15 (khtml, like gecko) version/13.0.1 mobile/15e148 safari/604.1",
"deviceId": "1.1|hfp9sLiKhAoWyNSMpiQGh|mozilla/5.0 (windows nt 6.1) applewebkit/537.36 (khtml, like gecko) chrome/92.0.4515.131 safari/537.36|24#1344#840#799|internal-pdf-viewer#mhjfbmdgcfjbbpaeojofohoefgiehjai#internal-nacl-plugin|Win32|1g0u1g01u0u10r1u0x10g1y0g1d0g10g1010u101g0g1u01r0x10x101g01a010u101g01010u101r01z01ij01a0u1u01rd01r0r101ir01ii01aj01ux01ui01iy01y01ui0g1y01r01d0|MS|-1397920487|c39b35be"
},
"url": {"ipnUrl": "https://google.com/gateway/webhook/245252525252525",
"redirectUrl": "https://google.com/gateway/redirect/245252525252525"
},
"metadata": {"foo": "bar"
},
"emailOptions": {"send": true
}
}

Response samples

201
400
401
403
500

Content type

application/json

{"payment": {"code": "0",
"description": "APPROVED",
"action": "charge",
"url": "https://google.com/oijhflsfs9",
"mode": "sale",
"status": "success",
"amount": 9.99,
"currency": "USD",
"orderId": "235324530",
"transactionId": "12345",
"descriptor": "centrohelp.com",
"source": {"method": "card",
"number": "402400****6348",
"brand": "visa",
"expirationMonth": 2,
"expirationYear": 27,
"paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
"disabled": true
}
},
"consumer": {"id": "string",
"externalId": "14253ms92m0as",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"phone": "+1987353539",
"country": "GBR",
"state": "string",
"city": "string",
"zip": "36101"
},
"subscription": {"id": "string",
"status": "active",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"cycle": 0
},
"metadata": {"foo": "bar"
},
"timestamp": {"dateTime": "2020-04-17 13:43:02",
"timezone": "UTC+02.00",
"unixTime": "1637063718"
}
}

Callback payload samples

Callback

POST: Payment status callback

Content type

application/json

{"payment": {"code": "0",
"description": "APPROVED",
"action": "charge",
"url": "https://google.com/oijhflsfs9",
"mode": "sale",
"status": "success",
"amount": 9.99,
"currency": "USD",
"orderId": "235324530",
"transactionId": "12345",
"descriptor": "centrohelp.com",
"source": {"method": "card",
"number": "402400****6348",
"brand": "visa",
"expirationMonth": 2,
"expirationYear": 27,
"paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
"disabled": true
}
},
"consumer": {"id": "string",
"externalId": "14253ms92m0as",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"phone": "+1987353539",
"country": "GBR",
"state": "string",
"city": "string",
"zip": "36101"
},
"subscription": {"id": "string",
"status": "active",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"cycle": 0
},
"metadata": {"foo": "bar"
},
"timestamp": {"dateTime": "2020-04-17 13:43:02",
"timezone": "UTC+02.00",
"unixTime": "1637063718"
}
}

Credit

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Transaction that should be credited

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

amount	number <double> (schemas) If the parameter is not passed, full amount is credited
reason required	string (schemas) [ 3 .. 64 ] characters Reason of operation

Responses

Request samples

Payload

Content type

application/json

{"amount": 9.99,
"reason": "Retention offer"
}

Response samples

201
400
401
403
500

Content type

application/json

{"payment": {"code": 0,
"description": "APPROVED",
"mode": "credit",
"status": "success",
"transactionId": "12345",
"descriptor": "example.com",
"source": {"method": "card",
"number": "402400****6348",
"paymentAccountId": "ae853c41-2d85-4c8a-9a61-3a5daeea311d",
"brand": "visa",
"expirationMonth": 10,
"expirationYear": 24,
"disabled": true
}
}
}

Payout

Authorizations:

ApiKeyAuth

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

consumerId	string [ 5 .. 36 ] characters Gateway consumer ID (user ID)
	object
paymentAccountId	string <uuid> ID of the encoded user payment details
siteId	string (schemas) [ 5 .. 36 ] characters Payout will be linked to the passed siteId, otherwise – to the first merchant site
	PayId (object) or Crypto (object) or ACH (object) or SEPA (object) or Pix (object) or Netbanking (object) Payout method
amount required	number <double> (schemas) Amount of operation
currency required	any <ISO3> (schemas) Operation currency. If your currency is not supported, we will automatically convert it to USD
	object
metadata	object (schemas) Use to store additional structured information associated with payment. For example, to tie transactions to the orders in your system

Responses

Request samples

Payload

Content type

application/json

{"consumerId": "41098035",
"paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
"siteId": 983759353,
"amount": 9.99,
"currency": "USD",
"url": {"ipnUrl": "https://google.com/gateway/webhook/245252525252525"
},
"metadata": {"foo": "bar"
}
}

Response samples

201
400
401
403
500

Content type

application/json

{"payment": {"code": "0",
"description": "APPROVED",
"action": "charge",
"mode": "payout",
"status": "success",
"amount": 9.99,
"currency": "USD",
"orderId": 235324530,
"transactionId": "12345",
"source": {"method": "card",
"number": "402400****6348",
"brand": "visa"
}
},
"consumer": {"id": "string",
"externalId": "14253ms92m0as",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"phone": "+1987353539",
"country": "GBR",
"state": "string",
"city": "string",
"zip": "36101"
},
"metadata": {"foo": "bar"
}
}

Subscription

Get subscription

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Subscription ID) [ 5 .. 36 ] characters

Subscription ID

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"type": "trial",
"cycle": 0,
"skuName": "TEST_EN",
"siteId": "983759353",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"consumerId": "string"
}

Change subscription recurrent plan

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Subscription ID) [ 5 .. 36 ] characters

Subscription ID

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

Array of objects (Price)

Responses

Request samples

Payload

Content type

application/json

{"price": [{"offset": "5d",
"amount": 9.99,
"currency": "USD",
"repeat": true
}
]
}

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"type": "trial",
"cycle": 0,
"skuName": "TEST_EN",
"siteId": "983759353",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"consumerId": "string"
}

Cancel subscription

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Subscription ID) [ 5 .. 36 ] characters

Subscription ID

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

cancelDate	string or null <date-time> (Date of cancel) If cancelDate is not passed or is set to null, subscription will be canceled immediately
reason	string or null <= 255 characters Provide the reason for subscription cancellation
sendEmail	boolean Send an email upon subscription cancellation. Set to true by default
keepActiveUntilNextRebill	boolean If passed, cancelDate will be set to 1 hour before the expected rebill date, overriding any previously passed cancelDate value

Responses

Request samples

Payload

Content type

application/json

{"cancelDate": "2020-11-17 13:43:02",
"reason": "Request from customer",
"sendEmail": true,
"keepActiveUntilNextRebill": true
}

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"type": "trial",
"cycle": 0,
"skuName": "TEST_EN",
"siteId": "983759353",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"consumerId": "string"
}

Recover already canceled subscription

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Subscription ID) [ 5 .. 36 ] characters

Subscription ID

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

reason

string or null <= 255 characters

Provide the reason for subscription recovery

Responses

Request samples

Payload

Content type

application/json

{"reason": "string"
}

Response samples

Content type

application/json

{"id": "string",
"status": "active",
"type": "trial",
"cycle": 0,
"skuName": "TEST_EN",
"siteId": "983759353",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"consumerId": "string"
}

Change payment account for subscription

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Subscription ID) [ 5 .. 36 ] characters

Gateway subscription ID

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

required	Credit card (object) or Sepa (object) or Token of tokenized card data (object) (Payment source)
required	object (Consumer)

Responses

Callbacks

Request samples

Payload

Content type

application/json

{"paymentSource": {"type": "card",
"number": "stringstring",
"expirationYear": "st",
"expirationMonth": "st",
"cvv": "stri",
"3ds": true,
"emulateCode": "5003",
"mid": "string",
"mpiParameters": {"authStatus": "Y",
"cavv": "kBMSV/fB8ausrgK8Xem8wIQBeP88",
"eci": "02",
"protocolVersion": 2,
"directoryServerTransactionId": "3ba1f2c9-613b-4c00-80b1-ec8869690b26",
"scaExemption": "lowValue"
}
},
"consumer": {"id": "string",
"externalId": "14253ms92m0as",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"phone": "+1987353539",
"country": "GBR",
"state": "string",
"city": "string",
"zip": "36101",
"ip": "string",
"userAgent": "string",
"deviceId": "string"
}
}

Response samples

Content type

application/json

{"payment": {"code": "0",
"description": "APPROVED",
"action": "charge",
"url": "https://google.com/oijhflsfs9",
"mode": "sale",
"status": "success",
"amount": 9.99,
"currency": "USD",
"orderId": "235324530",
"transactionId": "12345",
"descriptor": "centrohelp.com",
"source": {"method": "card",
"number": "402400****6348",
"brand": "visa",
"expirationMonth": 2,
"expirationYear": 27,
"paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
"disabled": true
}
},
"consumer": {"id": "string",
"externalId": "14253ms92m0as",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"phone": "+1987353539",
"country": "GBR",
"state": "string",
"city": "string",
"zip": "36101"
},
"subscription": {"id": "string",
"status": "active",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"cycle": 0
},
"metadata": {"foo": "bar"
},
"timestamp": {"dateTime": "2020-04-17 13:43:02",
"timezone": "UTC+02.00",
"unixTime": "1637063718"
}
}

Callback payload samples

Callback

POST: Payment status callback

Content type

application/json

{"payment": {"code": "0",
"description": "APPROVED",
"action": "charge",
"url": "https://google.com/oijhflsfs9",
"mode": "sale",
"status": "success",
"amount": 9.99,
"currency": "USD",
"orderId": "235324530",
"transactionId": "12345",
"descriptor": "centrohelp.com",
"source": {"method": "card",
"number": "402400****6348",
"brand": "visa",
"expirationMonth": 2,
"expirationYear": 27,
"paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb",
"disabled": true
}
},
"consumer": {"id": "string",
"externalId": "14253ms92m0as",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"phone": "+1987353539",
"country": "GBR",
"state": "string",
"city": "string",
"zip": "36101"
},
"subscription": {"id": "string",
"status": "active",
"renewalDate": "2020-04-17 13:43:02",
"cancelDate": "2020-11-17 13:43:02",
"cycle": 0
},
"metadata": {"foo": "bar"
},
"timestamp": {"dateTime": "2020-04-17 13:43:02",
"timezone": "UTC+02.00",
"unixTime": "1637063718"
}
}

Site

Create site

Authorizations:

ApiKeyAuth

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

name required	string (schemas) URL without protocol prefix
externalId	string (schemas) [ 3 .. 36 ] characters Merchant site ID
ipnUrl required	string <url> (schemas) The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase
redirectUrl	string <url> (schemas) User will be redirected to this URL after purchase

Responses

Request samples

Payload

Content type

application/json

{"name": "example.com",
"externalId": "14253ms92m0as",
"ipnUrl": "https://google.com/gateway/webhook/245252525252525",
"redirectUrl": "https://google.com/oijhflsfs9"
}

Response samples

200
400
401
403
500

Content type

application/json

{"id": "983759353",
"name": "example.com",
"externalId": "14253ms92m0as",
"ipnUrl": "https://google.com/gateway/webhook/245252525252525",
"redirectUrl": "https://google.com/oijhflsfs9",
"createdAt": "2020-04-17 13:43:02",
"updatedAt": "2020-11-17 13:43:02"
}

Get site

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Gateway site ID) [ 5 .. 36 ] characters

Example: 983759353

Gateway site ID (created on the Merchant portal)

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"id": "983759353",
"name": "example.com",
"externalId": "14253ms92m0as",
"ipnUrl": "https://google.com/gateway/webhook/245252525252525",
"redirectUrl": "https://google.com/oijhflsfs9",
"createdAt": "2020-04-17 13:43:02",
"updatedAt": "2020-11-17 13:43:02"
}

Update site

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Gateway site ID) [ 5 .. 36 ] characters

Example: 983759353

Gateway site ID (created on the Merchant portal)

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

name	string (schemas) URL without protocol prefix
externalId	string (schemas) [ 3 .. 36 ] characters Merchant site ID
ipnUrl	string <url> (schemas) The Instant payment notification (aka IPN or callback) will be sent to this URL after purchase
redirectUrl	string <url> (schemas) User will be redirected to this URL after purchase

Responses

Request samples

Payload

Content type

application/json

{"name": "example.com",
"externalId": "14253ms92m0as",
"ipnUrl": "https://google.com/gateway/webhook/245252525252525",
"redirectUrl": "https://google.com/oijhflsfs9"
}

Response samples

200
400
401
403
500

Content type

application/json

{"id": "983759353",
"name": "example.com",
"externalId": "14253ms92m0as",
"ipnUrl": "https://google.com/gateway/webhook/245252525252525",
"redirectUrl": "https://google.com/oijhflsfs9",
"createdAt": "2020-04-17 13:43:02",
"updatedAt": "2020-11-17 13:43:02"
}

Product

Create product (SKU)

Authorizations:

ApiKeyAuth

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

One of

type required	any Value: "subscription" Recurring product
siteId required	string (schemas) [ 5 .. 36 ] characters Gateway site ID (created on the Merchant portal)
title required	string (schemas) [ 3 .. 128 ] characters The product description that will be shown on the payment page
externalId	string (schemas) [ 3 .. 36 ] characters Merchant SKU ID
required	Array of objects (Price)

Responses

Request samples

Payload

Content type

application/json

{"type": "one-time",
"siteId": "983759353",
"externalId": "14253ms92m0as",
"title": "string",
"currency": "USD",
"amount": 9.99
}

Response samples

200
400
401
403
500

Content type

application/json

{"name": "TEST_EN",
"siteId": "983759353",
"externalId": "14253ms92m0as",
"title": "string",
"type": "one-time",
"price": 9.99,
"currency": "USD",
"createdAt": "2020-04-17 13:43:02",
"updatedAt": "2020-11-17 13:43:02"
}

Get product (SKU)

Authorizations:

ApiKeyAuth

path Parameters

name

required

string (Gateway SKU) [ 5 .. 36 ] characters

Example: TEST_EN

SKU name that you added when creating SKU

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"name": "TEST_EN",
"siteId": "983759353",
"externalId": "14253ms92m0as",
"title": "string",
"type": "one-time",
"price": 9.99,
"currency": "USD",
"createdAt": "2020-04-17 13:43:02",
"updatedAt": "2020-11-17 13:43:02"
}

Update product (SKU)

Authorizations:

ApiKeyAuth

path Parameters

name

required

string (Gateway SKU) [ 5 .. 36 ] characters

Example: TEST_EN

SKU name that you added when creating SKU

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

One of

type required	any Value: "subscription" Recurring product
siteId required	string (schemas) [ 5 .. 36 ] characters Gateway site ID (created on the Merchant portal)
title required	string (schemas) [ 3 .. 128 ] characters The product description that will be shown on the payment page
externalId	string (schemas) [ 3 .. 36 ] characters Merchant SKU ID
required	Array of objects (Price)

Responses

Request samples

Payload

Content type

application/json

Example

{"type": "subscription",
"siteId": "983759353",
"title": "Annual subscription",
"externalId": "7f9s7f9sfs9",
"price": [{"offset": "5d",
"amount": 9.99,
"currency": "USD",
"repeat": true
}
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"name": "TEST_EN",
"siteId": "983759353",
"externalId": "14253ms92m0as",
"title": "string",
"type": "one-time",
"price": 9.99,
"currency": "USD",
"createdAt": "2020-04-17 13:43:02",
"updatedAt": "2020-11-17 13:43:02"
}

Consumer

Create consumer (user)

Authorizations:

ApiKeyAuth

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

externalId

required

string (schemas) [ 3 .. 64 ] characters

Merchant consumer ID (user ID)

username

string (schemas) [ 1 .. 255 ] characters

Username

email

string <email> (schemas)

Email address

firstName

string (schemas) [ 1 .. 32 ] characters

First name

lastName

string (schemas) [ 1 .. 32 ] characters

Last name

birthday

null or string (schemas)

Date of birth

country

string <ISO3> (schemas)

Country name in ISO3 format

groupId

any (schemas)

Enum: 1 2 3 4 5

id	description
1	whitelist
2	blacklist
3	junior
4	senior
5	expert

Responses

Request samples

Payload

Content type

application/json

{"externalId": "14253ms92m0as",
"username": "Jonny Sonny",
"email": "jonny.sonny@google.com",
"firstName": "Jonny",
"lastName": "Sonny",
"birthday": "1987-12-23",
"country": "USA",
"groupId": 3
}

Response samples

201
400
401
403
500

Content type

application/json

{"id": "string",
"externalId": "14253ms92m0as",
"username": "string",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"birthday": "Yyyy-mm-dd",
"country": "GBR",
"groupId": 1,
"blocked": true
}

Get consumer (user)

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Gateway consumer ID) [ 5 .. 36 ] characters

Gateway consumer ID (user ID)

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"id": "string",
"externalId": "14253ms92m0as",
"username": "string",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"birthday": "Yyyy-mm-dd",
"country": "GBR",
"groupId": 1,
"blocked": true
}

Change group of consumer (user)

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Gateway consumer ID) [ 5 .. 36 ] characters

Gateway consumer ID (user ID)

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

groupId

any (schemas)

Enum: 1 2 3 4 5

id	description
1	whitelist
2	blacklist
3	junior
4	senior
5	expert

Responses

Request samples

Payload

Content type

application/json

{"groupId": 1
}

Response samples

200
400
401
403
500

Content type

application/json

{"id": "string",
"externalId": "14253ms92m0as",
"username": "string",
"email": "jonny.sonny@google.com",
"firstName": "string",
"lastName": "string",
"birthday": "Yyyy-mm-dd",
"country": "GBR",
"groupId": 1,
"blocked": true
}

List payment account IDs by consumer ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Gateway consumer ID) [ 5 .. 36 ] characters

Gateway consumer ID (user ID)

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

201
400
401
403
500

Content type

application/json

[{"method": "card",
"number": "537541****1917",
"paymentAccountId": "02a05129-dde6-4e2e-b11c-f9975f630be4",
"brand": "mastercard",
"expirationMonth": 5,
"expirationYear": 24,
"disabled": false
},
{"method": "card",
"number": "400000****0874",
"paymentAccountId": "59f990b3-3f90-401a-b4b4-09ef5de8dee9",
"brand": "visa",
"expirationMonth": "01",
"expirationYear": "26",
"disabled": false
},
{"method": "card",
"number": "401200****0007",
"paymentAccountId": "5c11fb2f-6e9a-4c04-98a7-7372801d6281",
"brand": "visa",
"expirationMonth": "02",
"expirationYear": "27",
"disabled": false
},
{"method": "card",
"number": "223344****2176",
"paymentAccountId": "ae853c41-2d85-4c8a-9a61-3a5daeea311d",
"brand": "mastercard",
"expirationMonth": "02",
"expirationYear": "25",
"disabled": false
},
{"method": "card",
"number": "424242****4242",
"paymentAccountId": "b327c4cf-9d79-45aa-bdf5-c5243744182b",
"brand": "visa",
"expirationMonth": "04",
"expirationYear": "24",
"disabled": false
},
{"method": "card",
"number": "223344****0243",
"paymentAccountId": "f06e2cf7-6083-449a-9d95-551321957497",
"brand": "mastercard",
"expirationMonth": "02",
"expirationYear": "26",
"disabled": false
}
]

Get limit of consumer

Authorizations:

ApiKeyAuth

path Parameters

id

required

string (Gateway consumer ID) [ 5 .. 36 ] characters

Gateway consumer ID (user ID)

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"limit": 0,
"balance": 0,
"nextQuickSaleStatus": "OK"
}

Test payment data

Get test payment data by ID

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Test payment data ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Delete test payment data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Test payment data ID

Responses

Response samples

500

Content type

application/json

{"message": "Internal server error"
}

Update balance of the test payment data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Request Body schema: application/json

balance

integer [ 1 .. 6 ] characters

Desired balance of the test payment data

Responses

Request samples

Payload

Content type

application/json

{"balance": 0
}

Response samples

200
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Create test payment details

Authorizations:

ApiKeyAuth

Request Body schema: application/json

type required	string [ 5 .. 36 ] characters Test payment data type
emulate3ds	boolean Set to true to emulate the 3DS flow for this test payment data
balance	integer [ 1 .. 4 ] characters Balance of the test payment details
allowedIps	Array of strings Allowed IPs array

Responses

Request samples

Payload

Content type

application/json

{"type": "visa",
"emulate3ds": "true",
"balance": "44"
}

Response samples

200
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Get list of the test payment data

Authorizations:

ApiKeyAuth

query Parameters

limit	integer Per page limit
type	string Type of the test payment data

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
401
404
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Unblock test payment data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Test payment data ID

Responses

Response samples

200
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Emulate 3Ds for the test payment data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Test payment data ID

Request Body schema: application/json

emulate3ds

boolean

Set to true to activate the 3DS or SCA authentication process for this transaction

Responses

Request samples

Payload

Content type

application/json

{"emulate3ds": false
}

Response samples

200
401
404
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Not emulate 3Ds for the test payment data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Test payment data ID

Request Body schema: application/json

emulate3ds

boolean

Set to true to activate the 3DS or SCA authentication process for this transaction

Responses

Request samples

Payload

Content type

application/json

{"emulate3ds": false
}

Response samples

200
401
404
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Update allowed IPs

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Test payment data ID

Request Body schema: application/json

Array

string

Responses

Request samples

Payload

Content type

application/json

["5.18.206.55",
"122.166.96.83"
]

Response samples

200
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Service

Our IP addresses

Responses

Response samples

200
500

Content type

application/json

["52.58.234.180",
"18.185.38.173",
"18.185.208.231",
"18.185.208.83"
]

Block test payment data

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Test payment data ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"id": 1234,
"type": "visa",
"emulate3ds": true,
"number": "4024007179366348",
"balance": 44,
"blocked": false,
"allowedIps": ["string"
],
"createdAt": "2022-01-27 10:11:39",
"updatedAt": "2022-01-27 10:11:39"
}

Get repaid link for chargeback

Authorizations:

ApiKeyAuth

path Parameters

id

required

string

Chargeback transaction ID

Responses

Response samples

200
401
404
500

Content type

application/json

{"url": "https://pay.centrobill.com/unique-hash"
}

Disable payment account for quick-sale

Authorizations:

ApiKeyAuth

path Parameters

paymentAccountId

required

string

ID of the encoded user payment details

Responses

Response samples

200

Content type

application/json

{"paymentAccountId": "ae853c41-2d85-4c8a-9a61-3a5daeea311d"
}

Enable payment account for quick-sale

Authorizations:

ApiKeyAuth

path Parameters

paymentAccountId

required

string

ID of the encoded user payment details

Responses

Response samples

200

Content type

application/json

{"paymentAccountId": "ae853c41-2d85-4c8a-9a61-3a5daeea311d"
}

Get ApplePay session

Authorizations:

ApiKeyAuth

Request Body schema: application/json

domain

required

string (schemas) [ 5 .. 36 ] characters

Website domain name without http(s) protocol

Responses

Request samples

Payload

Content type

application/json

{"domain": "pay.google.com"
}

Response samples

200
400
401
403
500

Content type

application/json

{"session": "string"
}

Verification

Get available channels of code verification

Authorizations:

ApiKeyAuth

path Parameters

phone

required

string (Consumer's phone number) [ 7 .. 18 ] characters

Example: +1987353539

Phone number

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
400
401
403
500

Content type

application/json

["sms",
"telegram",
"whatsapp"
]

Send message with verification code

Authorizations:

ApiKeyAuth

path Parameters

channel

required

string

Channel of message

header Parameters

X-Request-ID

string

Unique ID of request

Request Body schema: application/json

phone required	string (schemas) [ 7 .. 18 ] characters Phone number
from	string [ 3 .. 16 ] characters

Responses

Request samples

Payload

Content type

application/json

{"phone": "+1987353539",
"from": "Gateway"
}

Response samples

400
401
403
500

Content type

application/json

{"message": "Bad Request",
"errors": {"parameterName": "Parameter is invalid or missing"
}
}

Check verification code

Authorizations:

ApiKeyAuth

path Parameters

phone required	string (Consumer's phone number) [ 7 .. 18 ] characters Example: +1987353539 Phone number
code required	string Verification code

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

400
401
403
500

Content type

application/json

{"message": "Bad Request",
"errors": {"parameterName": "Parameter is invalid or missing"
}
}

Currency exchange rates

Get list of currency exchange rates

Authorizations:

ApiKeyAuth

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
400
401
403
500

Content type

application/json

[{"iso3": "EUR",
"usdPerUnit": 0.88,
"unitPerUsd": 1.13
}
]

Get exchange rate by ISO3

Authorizations:

ApiKeyAuth

path Parameters

iso3

required

any <ISO3> (Currency)

Example: USD

Currency of operation in ISO3 format

header Parameters

X-Request-ID

string

Unique ID of request

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"iso3": "EUR",
"usdPerUnit": 0.88,
"unitPerUsd": 1.13
}