logo
API docs by Redocly

Stancer API (v2)

Download OpenAPI specification:Download

customers

Customers

List Customers

Authorizations:
BasicBearer
query Parameters
created
integer (Created) >= 0
external_id
string (External Id) [ 1 .. 36 ] characters
email
string (Email) <= 64 characters
name
string (Name) <= 64 characters
country
string (Country) = 2 characters
legal_id
string (Legal Id) <= 16 characters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "customers": [
    ]
}

Create Customer

Authorizations:
BasicBearer
Request Body schema: application/json
required
email
string <email> (Email)

Customer email

name
string (Name) <= 64 characters

Customer name

mobile
string (Mobile) <= 16 characters

Customer mobile number

date_birth
string <date> (Date Birth)

Date of birth

legal_id
string (Legal Id) <= 16 characters

Any legal identifier like SIREN, CBE, KVK, etc

country
string (Country) = 2 characters

Country of the card issuer

external_id
string (External Id) [ 1 .. 36 ] characters

Unique id with unicity check

Responses

Request samples

Content type
application/json
{
  • "email": "test@test.com",
  • "name": "Arthur Martin",
  • "mobile": "+33100000000",
  • "date_birth": "1953-01-19",
  • "legal_id": "AA732A82C93V20",
  • "country": "FR",
  • "external_id": "UniqueId123"
}

Response samples

Content type
application/json
{
  • "id": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "country": "FR",
  • "created": "UniqueId123",
  • "date_birth": "1950-05-04",
  • "email": "test@test.com",
  • "external_id": "UniqueId123",
  • "legal_id": "AA732A82C93V20",
  • "mobile": "+33100000000",
  • "name": "Arthur Martin",
  • "deleted": true
}

Get Customer

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^cust_[a-zA-Z0-9]{24}$
Examples: cust_yWYfCSzsUUhr9KwMv7vuLZHX cust_SEqIZS1c23dfKculquz8idzR cust_Mu73X3xO3IEjjj8MlPsSGLbV cust_tY9xDPqoN4xxAuSkgElNacab cust_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "country": "FR",
  • "created": "UniqueId123",
  • "date_birth": "1950-05-04",
  • "email": "test@test.com",
  • "external_id": "UniqueId123",
  • "legal_id": "AA732A82C93V20",
  • "mobile": "+33100000000",
  • "name": "Arthur Martin",
  • "deleted": true
}

Customer Delete

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^cust_[a-zA-Z0-9]{24}$
Examples: cust_yWYfCSzsUUhr9KwMv7vuLZHX cust_SEqIZS1c23dfKculquz8idzR cust_Mu73X3xO3IEjjj8MlPsSGLbV cust_tY9xDPqoN4xxAuSkgElNacab cust_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "country": "FR",
  • "created": "UniqueId123",
  • "date_birth": "1950-05-04",
  • "email": "test@test.com",
  • "external_id": "UniqueId123",
  • "legal_id": "AA732A82C93V20",
  • "mobile": "+33100000000",
  • "name": "Arthur Martin",
  • "deleted": true
}

Update Customer

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^cust_[a-zA-Z0-9]{24}$
Examples: cust_yWYfCSzsUUhr9KwMv7vuLZHX cust_SEqIZS1c23dfKculquz8idzR cust_Mu73X3xO3IEjjj8MlPsSGLbV cust_tY9xDPqoN4xxAuSkgElNacab cust_5O6cpeO4Ofy1QqY2NfdzheAD
Request Body schema: application/json
required
email
string <email> (Email)

Customer email

name
string (Name) <= 64 characters

Customer name

mobile
string (Mobile) <= 16 characters

Customer mobile number

date_birth
string <date> (Date Birth)

Date of birth

legal_id
string (Legal Id) <= 16 characters

Any legal identifier like SIREN, CBE, KVK, etc

country
string (Country) = 2 characters

Country of the card issuer

external_id
string (External Id) [ 1 .. 36 ] characters

Unique id with unicity check

Responses

Request samples

Content type
application/json
{
  • "email": "test@test.com",
  • "name": "Arthur Martin",
  • "mobile": "+33100000000",
  • "date_birth": "1953-01-19",
  • "legal_id": "AA732A82C93V20",
  • "country": "FR",
  • "external_id": "UniqueId123"
}

Response samples

Content type
application/json
{
  • "id": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "country": "FR",
  • "created": "UniqueId123",
  • "date_birth": "1950-05-04",
  • "email": "test@test.com",
  • "external_id": "UniqueId123",
  • "legal_id": "AA732A82C93V20",
  • "mobile": "+33100000000",
  • "name": "Arthur Martin",
  • "deleted": true
}

cards

Cards

List Cards

Authorizations:
BasicBearer
query Parameters
customer
string (Customer) ^cust_[a-zA-Z0-9]{24}$
Examples: customer=cust_yWYfCSzsUUhr9KwMv7vuLZHX customer=cust_SEqIZS1c23dfKculquz8idzR customer=cust_Mu73X3xO3IEjjj8MlPsSGLbV customer=cust_tY9xDPqoN4xxAuSkgElNacab customer=cust_5O6cpeO4Ofy1QqY2NfdzheAD
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "cards": [
    ]
}

Create Card

Authorizations:
BasicBearer
Request Body schema: application/json
required
exp_month
required
integer (Exp Month) [ 1 .. 12 ]

Month expiration in MM format

exp_year
required
integer (Exp Year) [ 2019 .. 2099 ]

Year expiration in YYYY format

name
string (Name) <= 64 characters

custome name given to the card, often the card holder name

external_id
string (External Id) [ 1 .. 36 ] characters

Unique id with unicity check

zip_code
string (Zip Code) [ 2 .. 8 ] characters

zip code in 2 to 8 digit format

customer
string (Customer) ^cust_[a-zA-Z0-9]{24}$

Customer to assign the card

cvc
string (Cvc) [ 3 .. 4 ] characters

Card security code used to secure the transaction

number
required
string (Number) [ 13 .. 19 ] characters

Card number

tokenize
boolean (Tokenize)
Default: true

Define if card can be reused for future payments

Responses

Request samples

Content type
application/json
{
  • "exp_month": 12,
  • "exp_year": 2022,
  • "name": "My card",
  • "external_id": "UniqueId123",
  • "zip_code": "75001",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "cvc": "123",
  • "number": "4242424242424242",
  • "tokenize": true
}

Response samples

Content type
application/json
{
  • "customer": [
    ],
  • "brand": "visa",
  • "country": "FR",
  • "created": "1512518400",
  • "exp_month": 12,
  • "exp_year": 2022,
  • "external_id": "UniqueId123",
  • "funding": "credit",
  • "id": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "4242",
  • "name": "My card",
  • "nature": "personal",
  • "network": "visa",
  • "zip_code": "75001",
  • "deleted": true
}

Get Card

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^card_[a-zA-Z0-9]{24}$
Examples: card_yWYfCSzsUUhr9KwMv7vuLZHX card_SEqIZS1c23dfKculquz8idzR card_Mu73X3xO3IEjjj8MlPsSGLbV card_tY9xDPqoN4xxAuSkgElNacab card_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "customer": [
    ],
  • "brand": "visa",
  • "country": "FR",
  • "created": "1512518400",
  • "exp_month": 12,
  • "exp_year": 2022,
  • "external_id": "UniqueId123",
  • "funding": "credit",
  • "id": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "4242",
  • "name": "My card",
  • "nature": "personal",
  • "network": "visa",
  • "zip_code": "75001",
  • "deleted": true
}

Delete Card

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^card_[a-zA-Z0-9]{24}$
Examples: card_yWYfCSzsUUhr9KwMv7vuLZHX card_SEqIZS1c23dfKculquz8idzR card_Mu73X3xO3IEjjj8MlPsSGLbV card_tY9xDPqoN4xxAuSkgElNacab card_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "customer": [
    ],
  • "brand": "visa",
  • "country": "FR",
  • "created": "1512518400",
  • "exp_month": 12,
  • "exp_year": 2022,
  • "external_id": "UniqueId123",
  • "funding": "credit",
  • "id": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "4242",
  • "name": "My card",
  • "nature": "personal",
  • "network": "visa",
  • "zip_code": "75001",
  • "deleted": true
}

Update Card

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^card_[a-zA-Z0-9]{24}$
Examples: card_yWYfCSzsUUhr9KwMv7vuLZHX card_SEqIZS1c23dfKculquz8idzR card_Mu73X3xO3IEjjj8MlPsSGLbV card_tY9xDPqoN4xxAuSkgElNacab card_5O6cpeO4Ofy1QqY2NfdzheAD
Request Body schema: application/json
required
exp_month
integer (Exp Month) [ 1 .. 12 ]

Month in MM format

exp_year
integer (Exp Year) [ 2019 .. 2099 ]

Year expiration in YYYY format

external_id
string (External Id) [ 1 .. 36 ] characters

Unique id with unicity check

zip_code
string (Zip Code) [ 2 .. 8 ] characters

Zip code in 2 to 8 digit format

Responses

Request samples

Content type
application/json
{
  • "exp_month": 12,
  • "exp_year": 2022,
  • "external_id": "UniqueId123",
  • "zip_code": "75001"
}

Response samples

Content type
application/json
{
  • "customer": [
    ],
  • "brand": "visa",
  • "country": "FR",
  • "created": "1512518400",
  • "exp_month": 12,
  • "exp_year": 2022,
  • "external_id": "UniqueId123",
  • "funding": "credit",
  • "id": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "4242",
  • "name": "My card",
  • "nature": "personal",
  • "network": "visa",
  • "zip_code": "75001",
  • "deleted": true
}

sepa

SEPA

List Sepa

Authorizations:
BasicBearer
query Parameters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "sepa": [
    ]
}

Create Sepa

Authorizations:
BasicBearer
query Parameters
bic
boolean (Bic)

Only available for some specific companies

Request Body schema: application/json
required
mandate
string (Mandate) <= 35 characters

Mandate id

name
required
string (Name) <= 64 characters

Simple name identifying a mandate

date_mandate
string <date> (Date Mandate)

Mandate date in YYYY-MM-DD format

iban
required
string (Iban) [ 12 .. 34 ] characters

Iban

bic
string (Bic) <= 11 characters

Bic

customer
string (Customer) ^cust_[a-zA-Z0-9]{24}$

Responses

Request samples

Content type
application/json
{
  • "mandate": "maecux5aSa4ikae3kaiw9veivahpeer6",
  • "name": "Jean Dupont",
  • "date_mandate": "2021-06-14",
  • "iban": "FR1420041010050500013M02606",
  • "bic": "TESTFRPP",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Response samples

Content type
application/json
{
  • "bic": "TESTFRPP",
  • "created": "2019-08-24T14:15:22Z",
  • "date_mandate": "2023-04-18",
  • "id": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "2606",
  • "mandate": "5439018654a7585dfghj637192Dfdf5867604gs528",
  • "name": "Sepa1",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "deleted": true
}

Get Sepa

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa_SEqIZS1c23dfKculquz8idzR sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa_tY9xDPqoN4xxAuSkgElNacab sepa_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "bic": "TESTFRPP",
  • "created": "2019-08-24T14:15:22Z",
  • "date_mandate": "2023-04-18",
  • "id": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "2606",
  • "mandate": "5439018654a7585dfghj637192Dfdf5867604gs528",
  • "name": "Sepa1",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "deleted": true
}

Delete Sepa

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa_SEqIZS1c23dfKculquz8idzR sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa_tY9xDPqoN4xxAuSkgElNacab sepa_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "bic": "TESTFRPP",
  • "created": "2019-08-24T14:15:22Z",
  • "date_mandate": "2023-04-18",
  • "id": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "2606",
  • "mandate": "5439018654a7585dfghj637192Dfdf5867604gs528",
  • "name": "Sepa1",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "deleted": true
}

Update Sepa

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa_SEqIZS1c23dfKculquz8idzR sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa_tY9xDPqoN4xxAuSkgElNacab sepa_5O6cpeO4Ofy1QqY2NfdzheAD
Request Body schema: application/json
required
mandate
string (Mandate) <= 35 characters

Mandate id

name
string (Name) <= 64 characters

Simple name identifying a mandate

date_mandate
string <date> (Date Mandate)

Mandate date in YYYY-MM-DD format

Responses

Request samples

Content type
application/json
{
  • "mandate": "maecux5aSa4ikae3kaiw9veivahpeer6",
  • "name": "Sepa1",
  • "date_mandate": "2021-06-14"
}

Response samples

Content type
application/json
{
  • "bic": "TESTFRPP",
  • "created": "2019-08-24T14:15:22Z",
  • "date_mandate": "2023-04-18",
  • "id": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "2606",
  • "mandate": "5439018654a7585dfghj637192Dfdf5867604gs528",
  • "name": "Sepa1",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "deleted": true
}

Get Iban Only Deprecated

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa_SEqIZS1c23dfKculquz8idzR sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa_tY9xDPqoN4xxAuSkgElNacab sepa_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "bic": "TESTFRPP",
  • "created": "2019-08-24T14:15:22Z",
  • "date_mandate": "2023-04-18",
  • "id": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "2606",
  • "mandate": "5439018654a7585dfghj637192Dfdf5867604gs528",
  • "name": "Sepa1",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "deleted": true
}

Create Iban Only Deprecated

Authorizations:
BasicBearer
Request Body schema: application/json
required
mandate
string (Mandate) <= 35 characters

Mandate id

name
required
string (Name) <= 64 characters

Simple name identifying a mandate

date_mandate
string <date> (Date Mandate)

Mandate date in YYYY-MM-DD format

iban
required
string (Iban) [ 12 .. 34 ] characters

Iban

bic
string (Bic) <= 11 characters

Bic

customer
string (Customer) ^cust_[a-zA-Z0-9]{24}$

Responses

Request samples

Content type
application/json
{
  • "mandate": "maecux5aSa4ikae3kaiw9veivahpeer6",
  • "name": "Jean Dupont",
  • "date_mandate": "2021-06-14",
  • "iban": "FR1420041010050500013M02606",
  • "bic": "TESTFRPP",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Response samples

Content type
application/json
{
  • "bic": "TESTFRPP",
  • "created": "2019-08-24T14:15:22Z",
  • "date_mandate": "2023-04-18",
  • "id": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "last4": "2606",
  • "mandate": "5439018654a7585dfghj637192Dfdf5867604gs528",
  • "name": "Sepa1",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "deleted": true
}

mandates

Mandates

List Mandates

Authorizations:
BasicBearer
query Parameters
customer
string (Customer) ^cust_[a-zA-Z0-9]{24}$
Examples: customer=cust_yWYfCSzsUUhr9KwMv7vuLZHX customer=cust_SEqIZS1c23dfKculquz8idzR customer=cust_Mu73X3xO3IEjjj8MlPsSGLbV customer=cust_tY9xDPqoN4xxAuSkgElNacab customer=cust_5O6cpeO4Ofy1QqY2NfdzheAD
sepa
string (Sepa) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa=sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa=sepa_SEqIZS1c23dfKculquz8idzR sepa=sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa=sepa_tY9xDPqoN4xxAuSkgElNacab sepa=sepa_5O6cpeO4Ofy1QqY2NfdzheAD
rum
string (Rum) <= 24 characters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "mandates": [
    ]
}

Create Mandate

Authorizations:
BasicBearer
Request Body schema: application/json
required
sepa
required
string (Sepa) ^sepa_[a-zA-Z0-9]{24}$
rum
string (Rum) <= 24 characters
signed_at
string <date-time> (Signed At)

Responses

Request samples

Content type
application/json
{
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "rum": "string",
  • "signed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "mndt_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "rum": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "signed_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "upload_url": "http://example.com",
  • "sign_url": "http://example.com",
  • "url": "http://example.com"
}

Get Mandate Pdf

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^mndt_[a-zA-Z0-9]{24}$
Examples: mndt_yWYfCSzsUUhr9KwMv7vuLZHX mndt_SEqIZS1c23dfKculquz8idzR mndt_Mu73X3xO3IEjjj8MlPsSGLbV mndt_tY9xDPqoN4xxAuSkgElNacab mndt_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "error": "string"
}

Get Mandate

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^mndt_[a-zA-Z0-9]{24}$
Examples: mndt_yWYfCSzsUUhr9KwMv7vuLZHX mndt_SEqIZS1c23dfKculquz8idzR mndt_Mu73X3xO3IEjjj8MlPsSGLbV mndt_tY9xDPqoN4xxAuSkgElNacab mndt_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "mndt_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "rum": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "signed_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "upload_url": "http://example.com",
  • "sign_url": "http://example.com",
  • "url": "http://example.com"
}

Delete Mandate

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^mndt_[a-zA-Z0-9]{24}$
Examples: mndt_yWYfCSzsUUhr9KwMv7vuLZHX mndt_SEqIZS1c23dfKculquz8idzR mndt_Mu73X3xO3IEjjj8MlPsSGLbV mndt_tY9xDPqoN4xxAuSkgElNacab mndt_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "mndt_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "rum": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "signed_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "upload_url": "http://example.com",
  • "sign_url": "http://example.com",
  • "url": "http://example.com"
}

Update Mandate

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^mndt_[a-zA-Z0-9]{24}$
Examples: mndt_yWYfCSzsUUhr9KwMv7vuLZHX mndt_SEqIZS1c23dfKculquz8idzR mndt_Mu73X3xO3IEjjj8MlPsSGLbV mndt_tY9xDPqoN4xxAuSkgElNacab mndt_5O6cpeO4Ofy1QqY2NfdzheAD
Request Body schema: application/json
required
rum
string (Rum) <= 24 characters
pdf
string (Pdf)
signed_at
string <date-time> (Signed At)

Responses

Request samples

Content type
application/json
{
  • "rum": "string",
  • "pdf": "string",
  • "signed_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "id": "mndt_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "rum": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "signed_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "upload_url": "http://example.com",
  • "sign_url": "http://example.com",
  • "url": "http://example.com"
}

payment_intents

Payment intents

List Payment Intents

Authorizations:
BasicBearer
query Parameters
order_id
string <binary> (Order Id) [ 1 .. 36 ] characters
card
string (Card) ^card_[a-zA-Z0-9]{24}$
Examples: card=card_yWYfCSzsUUhr9KwMv7vuLZHX card=card_SEqIZS1c23dfKculquz8idzR card=card_Mu73X3xO3IEjjj8MlPsSGLbV card=card_tY9xDPqoN4xxAuSkgElNacab card=card_5O6cpeO4Ofy1QqY2NfdzheAD
sepa
string (Sepa) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa=sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa=sepa_SEqIZS1c23dfKculquz8idzR sepa=sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa=sepa_tY9xDPqoN4xxAuSkgElNacab sepa=sepa_5O6cpeO4Ofy1QqY2NfdzheAD
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "payment_intents": [
    ]
}

Create Payment Intent

Authorizations:
BasicBearer
Request Body schema: application/json
required
description
string (Description) [ 3 .. 64 ] characters
amount
required
integer (Amount) [ 0 .. 4294967295 ]
currency
string (Currency)
Default: "eur"
Enum: "eur" "aud" "cad" "chf" "dkk" "gbp" "nok" "pln" "sek" "usd"
customer
string (Customer) ^cust_[a-zA-Z0-9]{24}$
order_id
string <binary> (Order Id) [ 1 .. 36 ] characters
methods_allowed
Array of strings (PaymentMethod) unique
Default: ["card","sepa"]
Items Enum: "card" "sepa"
card
string (Card) ^card_[a-zA-Z0-9]{24}$
sepa
string (Sepa) ^sepa_[a-zA-Z0-9]{24}$
metadata
any (Metadata)
return_url
string <uri> (Return Url) [ 1 .. 65536 ] characters
threeds
string (ThreeDSMode)
Default: "required"
Enum: "required" "none"

An enumeration.

capture
boolean (Capture)
Default: true

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "amount": 4294967295,
  • "currency": "eur",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "order_id": "string",
  • "methods_allowed": [
    ],
  • "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "metadata": null,
  • "return_url": "http://example.com",
  • "threeds": "required",
  • "capture": true
}

Response samples

Content type
application/json
{
  • "id": "pi_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "methods_allowed": [
    ],
  • "order_id": "string",
  • "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 4294967295,
  • "currency": "str",
  • "description": "string",
  • "status": "require_payment_method",
  • "metadata": null,
  • "url": "http://example.com",
  • "threeds": "required",
  • "return_url": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "capture": true
}

Get Payment Intent

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pi_[a-zA-Z0-9]{24}$
Examples: pi_yWYfCSzsUUhr9KwMv7vuLZHX pi_SEqIZS1c23dfKculquz8idzR pi_Mu73X3xO3IEjjj8MlPsSGLbV pi_tY9xDPqoN4xxAuSkgElNacab pi_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "pi_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "methods_allowed": [
    ],
  • "order_id": "string",
  • "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 4294967295,
  • "currency": "str",
  • "description": "string",
  • "status": "require_payment_method",
  • "metadata": null,
  • "url": "http://example.com",
  • "threeds": "required",
  • "return_url": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "capture": true
}

Delete Payment Intent

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pi_[a-zA-Z0-9]{24}$
Examples: pi_yWYfCSzsUUhr9KwMv7vuLZHX pi_SEqIZS1c23dfKculquz8idzR pi_Mu73X3xO3IEjjj8MlPsSGLbV pi_tY9xDPqoN4xxAuSkgElNacab pi_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "pi_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "methods_allowed": [
    ],
  • "order_id": "string",
  • "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 4294967295,
  • "currency": "str",
  • "description": "string",
  • "status": "require_payment_method",
  • "metadata": null,
  • "url": "http://example.com",
  • "threeds": "required",
  • "return_url": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "capture": true
}

Update Payment Intent

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pi_[a-zA-Z0-9]{24}$
Examples: pi_yWYfCSzsUUhr9KwMv7vuLZHX pi_SEqIZS1c23dfKculquz8idzR pi_Mu73X3xO3IEjjj8MlPsSGLbV pi_tY9xDPqoN4xxAuSkgElNacab pi_5O6cpeO4Ofy1QqY2NfdzheAD
Request Body schema: application/json
required
description
string (Description) [ 3 .. 64 ] characters
amount
integer (Amount) [ 0 .. 4294967295 ]
currency
string (Currency)
Enum: "eur" "aud" "cad" "chf" "dkk" "gbp" "nok" "pln" "sek" "usd"
customer
string (Customer) ^cust_[a-zA-Z0-9]{24}$
order_id
string <binary> (Order Id) [ 1 .. 36 ] characters
methods_allowed
Array of strings (PaymentMethod) unique
Items Enum: "card" "sepa"
card
string (Card) ^card_[a-zA-Z0-9]{24}$
sepa
string (Sepa) ^sepa_[a-zA-Z0-9]{24}$
metadata
any (Metadata)
return_url
string <uri> (Return Url) [ 1 .. 65536 ] characters
threeds
string (ThreeDSMode)
Enum: "required" "none"

An enumeration.

capture
boolean (Capture)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "amount": 4294967295,
  • "currency": "eur",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "order_id": "string",
  • "methods_allowed": [
    ],
  • "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "metadata": null,
  • "return_url": "http://example.com",
  • "threeds": "required",
  • "capture": true
}

Response samples

Content type
application/json
{
  • "id": "pi_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "methods_allowed": [
    ],
  • "order_id": "string",
  • "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 4294967295,
  • "currency": "str",
  • "description": "string",
  • "status": "require_payment_method",
  • "metadata": null,
  • "url": "http://example.com",
  • "threeds": "required",
  • "return_url": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "capture": true
}

Capture Payment Intent

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pi_[a-zA-Z0-9]{24}$
Examples: pi_yWYfCSzsUUhr9KwMv7vuLZHX pi_SEqIZS1c23dfKculquz8idzR pi_Mu73X3xO3IEjjj8MlPsSGLbV pi_tY9xDPqoN4xxAuSkgElNacab pi_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "pi_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "customer": "cust_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "methods_allowed": [
    ],
  • "order_id": "string",
  • "card": "card_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "sepa": "sepa_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 4294967295,
  • "currency": "str",
  • "description": "string",
  • "status": "require_payment_method",
  • "metadata": null,
  • "url": "http://example.com",
  • "threeds": "required",
  • "return_url": "http://example.com",
  • "created_at": "2019-08-24T14:15:22Z",
  • "capture": true
}

Get Payments Payment Intent

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pi_[a-zA-Z0-9]{24}$
Examples: pi_yWYfCSzsUUhr9KwMv7vuLZHX pi_SEqIZS1c23dfKculquz8idzR pi_Mu73X3xO3IEjjj8MlPsSGLbV pi_tY9xDPqoN4xxAuSkgElNacab pi_5O6cpeO4Ofy1QqY2NfdzheAD
query Parameters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "payments": [
    ]
}

payments

Payments

List Payments Deprecated

Authorizations:
BasicBearer
query Parameters
created
integer (Created) >= 0
unique_id
string <binary> (Unique Id) [ 1 .. 36 ] characters
order_id
string <binary> (Order Id) [ 1 .. 36 ] characters
card
string (Card) ^card_[a-zA-Z0-9]{24}$
Examples: card=card_yWYfCSzsUUhr9KwMv7vuLZHX card=card_SEqIZS1c23dfKculquz8idzR card=card_Mu73X3xO3IEjjj8MlPsSGLbV card=card_tY9xDPqoN4xxAuSkgElNacab card=card_5O6cpeO4Ofy1QqY2NfdzheAD
sepa
string (Sepa) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa=sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa=sepa_SEqIZS1c23dfKculquz8idzR sepa=sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa=sepa_tY9xDPqoN4xxAuSkgElNacab sepa=sepa_5O6cpeO4Ofy1QqY2NfdzheAD
payout
string (Payout) ^pout_[a-zA-Z0-9]{24}$
Examples: payout=pout_yWYfCSzsUUhr9KwMv7vuLZHX payout=pout_SEqIZS1c23dfKculquz8idzR payout=pout_Mu73X3xO3IEjjj8MlPsSGLbV payout=pout_tY9xDPqoN4xxAuSkgElNacab payout=pout_5O6cpeO4Ofy1QqY2NfdzheAD
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "payments": [
    ]
}

Create Payment Deprecated

Authorizations:
BasicBearer
Request Body schema: application/json
required
amount
required
integer (Amount) [ 0 .. 4294967295 ]

Amount in positive integer format

currency
string (Currency)
Default: "eur"
Enum: "eur" "aud" "cad" "chf" "dkk" "gbp" "nok" "pln" "sek" "usd"

Currency

AuthIn (object) or Auth (boolean) (Auth)
CardIn (object) or Card (string) (Card)

Card associated with the payment

SepaPostCheckout (object) or Sepa (string) (Sepa)

Sepa associated with the payment

object (Wallet)

Wallet object containing a wallet payment token

methods_allowed
Array of strings (PaymentMethod) unique
Items Enum: "card" "sepa"

All methods allowed for the payment

CustomerIn (object) or Customer (string) (Customer)
description
string (Description) [ 3 .. 64 ] characters

Amount in positive integer format

object (Device)
Order Id (string) or DevicePhone (object) (Order Id)

Non unique id without unicity check

unique_id
string <binary> (Unique Id) [ 1 .. 36 ] characters

Unique id with unicity check

date_settlement
string <date> (Date Settlement)

Settlement date in YYYY-MM-DD format

return_url
string <uri> (Return Url) [ 1 .. 65536 ] characters

Merchant return url

capture
boolean (Capture)
Default: true

Capture the funds or not

Responses

Request samples

Content type
application/json
Example

A payment without any method yet

{
  • "amount": 50,
  • "currency": "eur"
}

Response samples

Content type
application/json
{
  • "id": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "auth": {
    },
  • "capture": true,
  • "created": "1512518400",
  • "currency": "eur",
  • "customer": {
    },
  • "date_settlement": "2021-09-10",
  • "date_bank": "2021-09-11",
  • "description": "A simple description",
  • "device": {
    },
  • "fee": 2,
  • "method": "card",
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "unique_id": "UniqueId123",
  • "response": "00",
  • "response_author": "string",
  • "return_url": "https://stancer.com",
  • "card": {
    },
  • "sepa": {
    },
  • "status": "refused"
}

Get Payment Deprecated

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "auth": {
    },
  • "capture": true,
  • "created": "1512518400",
  • "currency": "eur",
  • "customer": {
    },
  • "date_settlement": "2021-09-10",
  • "date_bank": "2021-09-11",
  • "description": "A simple description",
  • "device": {
    },
  • "fee": 2,
  • "method": "card",
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "unique_id": "UniqueId123",
  • "response": "00",
  • "response_author": "string",
  • "return_url": "https://stancer.com",
  • "card": {
    },
  • "sepa": {
    },
  • "status": "refused"
}

Update Payment Deprecated

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD
Request Body schema: application/json
required
amount
integer (Amount) [ 0 .. 4294967295 ]

Amount in positive integer format

AuthIn (object) or Auth (boolean) (Auth)

Activate 3ds authentication system

CardIn (object) or Card (string) (Card)
SepaIn (object) or Sepa (string) (Sepa)
object (ApplePay)
currency
string (Currency)
Enum: "eur" "aud" "cad" "chf" "dkk" "gbp" "nok" "pln" "sek" "usd"

Currency in 3 digit format

CustomerIn (object) or Customer (string) (Customer)
description
string (Description) [ 3 .. 64 ] characters

A small description

object (Device)
methods_allowed
Array of strings (PaymentMethod) [ 1 .. 2 ] items unique
Items Enum: "card" "sepa"
order_id
string <binary> (Order Id) [ 1 .. 36 ] characters

Non unique id without unicity check

return_url
string <uri> (Return Url) [ 1 .. 65536 ] characters
status
string (Status)
capture
boolean (Capture)

Capture status of the payment

date_settlement
string <date> (Date Settlement)

Settlement date in YYYY-MM-DD format

Responses

Request samples

Content type
application/json
{
  • "amount": 50,
  • "auth": true,
  • "card": {
    },
  • "sepa": {
    },
  • "wallet": {
    },
  • "currency": "eur",
  • "customer": {
    },
  • "description": "i am a simple description",
  • "device": {
    },
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "return_url": "http://example.com",
  • "status": "string",
  • "capture": true,
  • "date_settlement": "2021-08-23"
}

Response samples

Content type
application/json
{
  • "id": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "auth": {
    },
  • "capture": true,
  • "created": "1512518400",
  • "currency": "eur",
  • "customer": {
    },
  • "date_settlement": "2021-09-10",
  • "date_bank": "2021-09-11",
  • "description": "A simple description",
  • "device": {
    },
  • "fee": 2,
  • "method": "card",
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "unique_id": "UniqueId123",
  • "response": "00",
  • "response_author": "string",
  • "return_url": "https://stancer.com",
  • "card": {
    },
  • "sepa": {
    },
  • "status": "refused"
}

Get Payment Refunds Deprecated

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Payment Disputes Deprecated

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

List Payments

Authorizations:
BasicBearer
query Parameters
created
integer (Created) >= 0
unique_id
string <binary> (Unique Id) [ 1 .. 36 ] characters
order_id
string <binary> (Order Id) [ 1 .. 36 ] characters
card
string (Card) ^card_[a-zA-Z0-9]{24}$
Examples: card=card_yWYfCSzsUUhr9KwMv7vuLZHX card=card_SEqIZS1c23dfKculquz8idzR card=card_Mu73X3xO3IEjjj8MlPsSGLbV card=card_tY9xDPqoN4xxAuSkgElNacab card=card_5O6cpeO4Ofy1QqY2NfdzheAD
sepa
string (Sepa) ^sepa_[a-zA-Z0-9]{24}$
Examples: sepa=sepa_yWYfCSzsUUhr9KwMv7vuLZHX sepa=sepa_SEqIZS1c23dfKculquz8idzR sepa=sepa_Mu73X3xO3IEjjj8MlPsSGLbV sepa=sepa_tY9xDPqoN4xxAuSkgElNacab sepa=sepa_5O6cpeO4Ofy1QqY2NfdzheAD
payout
string (Payout) ^pout_[a-zA-Z0-9]{24}$
Examples: payout=pout_yWYfCSzsUUhr9KwMv7vuLZHX payout=pout_SEqIZS1c23dfKculquz8idzR payout=pout_Mu73X3xO3IEjjj8MlPsSGLbV payout=pout_tY9xDPqoN4xxAuSkgElNacab payout=pout_5O6cpeO4Ofy1QqY2NfdzheAD
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "payments": [
    ]
}

Create Payment

Authorizations:
BasicBearer
Request Body schema: application/json
required
amount
required
integer (Amount) [ 0 .. 4294967295 ]

Amount in positive integer format

currency
string (Currency)
Default: "eur"
Enum: "eur" "aud" "cad" "chf" "dkk" "gbp" "nok" "pln" "sek" "usd"

Currency

AuthIn (object) or Auth (boolean) (Auth)
CardIn (object) or Card (string) (Card)

Card associated with the payment

SepaPostCheckout (object) or Sepa (string) (Sepa)

Sepa associated with the payment

object (Wallet)

Wallet object containing a wallet payment token

methods_allowed
Array of strings (PaymentMethod) unique
Items Enum: "card" "sepa"

All methods allowed for the payment

CustomerIn (object) or Customer (string) (Customer)
description
string (Description) [ 3 .. 64 ] characters

Amount in positive integer format

object (Device)
Order Id (string) or DevicePhone (object) (Order Id)

Non unique id without unicity check

unique_id
string <binary> (Unique Id) [ 1 .. 36 ] characters

Unique id with unicity check

date_settlement
string <date> (Date Settlement)

Settlement date in YYYY-MM-DD format

return_url
string <uri> (Return Url) [ 1 .. 65536 ] characters

Merchant return url

capture
boolean (Capture)
Default: true

Capture the funds or not

Responses

Request samples

Content type
application/json
Example

A payment without any method yet

{
  • "amount": 50,
  • "currency": "eur"
}

Response samples

Content type
application/json
{
  • "id": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "auth": {
    },
  • "capture": true,
  • "created": "1512518400",
  • "currency": "eur",
  • "customer": {
    },
  • "date_settlement": "2021-09-10",
  • "date_bank": "2021-09-11",
  • "description": "A simple description",
  • "device": {
    },
  • "fee": 2,
  • "method": "card",
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "unique_id": "UniqueId123",
  • "response": "00",
  • "response_author": "string",
  • "return_url": "https://stancer.com",
  • "card": {
    },
  • "sepa": {
    },
  • "status": "refused"
}

Get Payment

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "auth": {
    },
  • "capture": true,
  • "created": "1512518400",
  • "currency": "eur",
  • "customer": {
    },
  • "date_settlement": "2021-09-10",
  • "date_bank": "2021-09-11",
  • "description": "A simple description",
  • "device": {
    },
  • "fee": 2,
  • "method": "card",
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "unique_id": "UniqueId123",
  • "response": "00",
  • "response_author": "string",
  • "return_url": "https://stancer.com",
  • "card": {
    },
  • "sepa": {
    },
  • "status": "refused"
}

Update Payment

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD
Request Body schema: application/json
required
amount
integer (Amount) [ 0 .. 4294967295 ]

Amount in positive integer format

AuthIn (object) or Auth (boolean) (Auth)

Activate 3ds authentication system

CardIn (object) or Card (string) (Card)
SepaIn (object) or Sepa (string) (Sepa)
object (ApplePay)
currency
string (Currency)
Enum: "eur" "aud" "cad" "chf" "dkk" "gbp" "nok" "pln" "sek" "usd"

Currency in 3 digit format

CustomerIn (object) or Customer (string) (Customer)
description
string (Description) [ 3 .. 64 ] characters

A small description

object (Device)
methods_allowed
Array of strings (PaymentMethod) [ 1 .. 2 ] items unique
Items Enum: "card" "sepa"
order_id
string <binary> (Order Id) [ 1 .. 36 ] characters

Non unique id without unicity check

return_url
string <uri> (Return Url) [ 1 .. 65536 ] characters
status
string (Status)
capture
boolean (Capture)

Capture status of the payment

date_settlement
string <date> (Date Settlement)

Settlement date in YYYY-MM-DD format

Responses

Request samples

Content type
application/json
{
  • "amount": 50,
  • "auth": true,
  • "card": {
    },
  • "sepa": {
    },
  • "wallet": {
    },
  • "currency": "eur",
  • "customer": {
    },
  • "description": "i am a simple description",
  • "device": {
    },
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "return_url": "http://example.com",
  • "status": "string",
  • "capture": true,
  • "date_settlement": "2021-08-23"
}

Response samples

Content type
application/json
{
  • "id": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "auth": {
    },
  • "capture": true,
  • "created": "1512518400",
  • "currency": "eur",
  • "customer": {
    },
  • "date_settlement": "2021-09-10",
  • "date_bank": "2021-09-11",
  • "description": "A simple description",
  • "device": {
    },
  • "fee": 2,
  • "method": "card",
  • "methods_allowed": [
    ],
  • "order_id": "NonUniqueId123",
  • "unique_id": "UniqueId123",
  • "response": "00",
  • "response_author": "string",
  • "return_url": "https://stancer.com",
  • "card": {
    },
  • "sepa": {
    },
  • "status": "refused"
}

Get Payment Refunds

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Payment Disputes

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^paym_[a-zA-Z0-9]{24}$
Examples: paym_yWYfCSzsUUhr9KwMv7vuLZHX paym_SEqIZS1c23dfKculquz8idzR paym_Mu73X3xO3IEjjj8MlPsSGLbV paym_tY9xDPqoN4xxAuSkgElNacab paym_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
[
  • {
    }
]

refunds

Refunds

List Refunds

Authorizations:
BasicBearer
query Parameters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "refunds": [
    ]
}

Create Refund

Authorizations:
BasicBearer
Request Body schema: application/json
required
payment
required
string (Payment) ^paym_[a-zA-Z0-9]{24}$
amount
integer (Amount) [ 0 .. 4294967295 ]

Responses

Request samples

Content type
application/json
{
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 4294967295
}

Response samples

Content type
application/json
{
  • "id": "refd_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "currency": "eur",
  • "date_bank": "2023-08-16",
  • "date_refund": "2023-08-15",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "created": "1512518400",
  • "status": "to_refund"
}

Get Refund

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^refd_[a-zA-Z0-9]{24}$
Examples: refd_yWYfCSzsUUhr9KwMv7vuLZHX refd_SEqIZS1c23dfKculquz8idzR refd_Mu73X3xO3IEjjj8MlPsSGLbV refd_tY9xDPqoN4xxAuSkgElNacab refd_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "refd_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "currency": "eur",
  • "date_bank": "2023-08-16",
  • "date_refund": "2023-08-15",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "created": "1512518400",
  • "status": "to_refund"
}

disputes

Disputes

List Disputes

Authorizations:
BasicBearer
query Parameters
created
integer (Created) >= 0
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "disputes": [
    ]
}

Get Dispute

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^dspt_[a-zA-Z0-9]{24}$
Examples: dspt_yWYfCSzsUUhr9KwMv7vuLZHX dspt_SEqIZS1c23dfKculquz8idzR dspt_Mu73X3xO3IEjjj8MlPsSGLbV dspt_tY9xDPqoN4xxAuSkgElNacab dspt_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "dspt_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "amount": 50,
  • "currency": "str",
  • "date_bank": "1512518999",
  • "order_id": "NonUniqueId123",
  • "payment": "paym_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "response": "string",
  • "created": "1512518400",
  • "type": "string"
}

payouts

Payouts

List Payouts

Authorizations:
BasicBearer
query Parameters
created
string <date-time> (Created)
payment
string (Payment) ^paym_[a-zA-Z0-9]{24}$
Examples: payment=paym_yWYfCSzsUUhr9KwMv7vuLZHX payment=paym_SEqIZS1c23dfKculquz8idzR payment=paym_Mu73X3xO3IEjjj8MlPsSGLbV payment=paym_tY9xDPqoN4xxAuSkgElNacab payment=paym_5O6cpeO4Ofy1QqY2NfdzheAD
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "payouts": [
    ]
}

Create Payout

Authorizations:
BasicBearer
Request Body schema: application/json
required
payments
Array of strings (Payments) [^paym_[a-zA-Z0-9]{24}$]
Default: []
disputes
Array of strings (Disputes) [^dspt_[a-zA-Z0-9]{24}$]
Default: []
refunds
Array of strings (Refunds) [^refd_[a-zA-Z0-9]{24}$]
Default: []
status
string (PayoutStatusCode)
Default: "paid"
Enum: "pending" "to_pay" "sent" "paid" "failed" "error"

An enumeration.

date
string <date> (Date)
description
string (Description)

Responses

Request samples

Content type
application/json
{
  • "payments": [ ],
  • "disputes": [ ],
  • "refunds": [ ],
  • "status": "paid",
  • "date": "2019-08-24",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": "pout_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "currency": "str",
  • "payments": {
    },
  • "refunds": {
    },
  • "disputes": {
    },
  • "fees": 4294967295,
  • "fees_vat": 4294967295,
  • "status": "pending",
  • "date": "2019-08-24"
}

Get Payout

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pout_[a-zA-Z0-9]{24}$
Examples: pout_yWYfCSzsUUhr9KwMv7vuLZHX pout_SEqIZS1c23dfKculquz8idzR pout_Mu73X3xO3IEjjj8MlPsSGLbV pout_tY9xDPqoN4xxAuSkgElNacab pout_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "pout_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "currency": "str",
  • "payments": {
    },
  • "refunds": {
    },
  • "disputes": {
    },
  • "fees": 4294967295,
  • "fees_vat": 4294967295,
  • "status": "pending",
  • "date": "2019-08-24"
}

List Payout Payments

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pout_[a-zA-Z0-9]{24}$
Examples: pout_yWYfCSzsUUhr9KwMv7vuLZHX pout_SEqIZS1c23dfKculquz8idzR pout_Mu73X3xO3IEjjj8MlPsSGLbV pout_tY9xDPqoN4xxAuSkgElNacab pout_5O6cpeO4Ofy1QqY2NfdzheAD
query Parameters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "payments": [
    ]
}

List Payout Refunds

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pout_[a-zA-Z0-9]{24}$
Examples: pout_yWYfCSzsUUhr9KwMv7vuLZHX pout_SEqIZS1c23dfKculquz8idzR pout_Mu73X3xO3IEjjj8MlPsSGLbV pout_tY9xDPqoN4xxAuSkgElNacab pout_5O6cpeO4Ofy1QqY2NfdzheAD
query Parameters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "refunds": [
    ]
}

List Payout Disputes

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^pout_[a-zA-Z0-9]{24}$
Examples: pout_yWYfCSzsUUhr9KwMv7vuLZHX pout_SEqIZS1c23dfKculquz8idzR pout_Mu73X3xO3IEjjj8MlPsSGLbV pout_tY9xDPqoN4xxAuSkgElNacab pout_5O6cpeO4Ofy1QqY2NfdzheAD
query Parameters
start
integer (Start) >= 0
Default: 0
limit
integer (Limit) [ 1 .. 100 ]
Default: 10

Responses

Response samples

Content type
application/json
{
  • "range": {
    },
  • "disputes": [
    ]
}

products

Products

prices

Prices

subscriptions

Subscriptions

webhooks

Webhooks

sepa_check

SEPA check

Get Sepa Check

Authorizations:
BasicBearer
path Parameters
id
required
string (Id) ^chck_[a-zA-Z0-9]{24}$
Examples: chck_yWYfCSzsUUhr9KwMv7vuLZHX chck_SEqIZS1c23dfKculquz8idzR chck_Mu73X3xO3IEjjj8MlPsSGLbV chck_tY9xDPqoN4xxAuSkgElNacab chck_5O6cpeO4Ofy1QqY2NfdzheAD

Responses

Response samples

Content type
application/json
{
  • "id": "chck_yWYfCSzsUUhr9KwMv7vuLZHX",
  • "created": "1512518400",
  • "person": {
    },
  • "company": {
    },
  • "check_type": "person",
  • "status": "pending"
}

Create Sepa Check

Create a new sepa check interrogation session.

Company identifier supported per country
Country Name Country Code SIREN VAT SIRET
France FR ✔ ✔ ✔
Italy IT ✔

Usage of an iban generated using the /generate route is mandatory in test mode.

Usage of this route in production mode is subject to additional fees.

For further information, please refer to Stancer's pricing conditions .

Authorizations:
BasicBearer
Request Body schema: application/json
required
object (SepaCheckPerson)

Sepa Check base model for customer search

object (SepaCheckCompany)

Sepa Check base model for customer search

iban
required
string (Iban) [ 12 .. 34 ] characters

IBAN

Responses

Request samples

Content type
application/json
Example

A Simple person check request

{
  • "person": {
    },
  • "iban": "FR7664082183260009001300192"
}

Response samples

Content type
application/json
{
  • "id": "chck_yWYfCSzsUUhr9KwMv7vuLZHX"
}

Generate Valid Check Iban

Authorizations:
BasicBearer
Request Body schema: application/json
required
object (SepaCheckPersonResponse)

Sepa check person score model

object (SepaCheckCompanyResponse)

Sepa check company score model

status
required
string (CheckStatus)
Enum: "pending" "succeeded"

An enumeration.

Responses

Request samples

Content type
application/json
{
  • "person": {
    },
  • "company": {
    },
  • "status": "pending"
}

Response samples

Content type
application/json
"stringstring"