Customers | SumUp Developer

Allow your regular customers to save their information with the Customers model.

This will prevent re-entering payment instrument information for recurring payments on your platform.

Depending on the needs you can allow, creating, listing or deactivating payment instruments & creating, retrieving and updating customers.

The Customer object

Saved customer details.

customer_idstringrequired
Unique ID of the customer.

Example: "831ff8d4cd5958ab5670"
personal_detailsPersonal Details
Personal details for the customer.
Show attributes
Close
Personal Details
- first_namestring
  First name of the customer.
  
  Example: "John"
- last_namestring
  Last name of the customer.
  
  Example: "Doe"
- emailstring
  Email address of the customer.
  
  Example: "user@example.com"
- phonestring
  Phone number of the customer.
  
  Example: "+491635559723"
- birth_datestringformat: date
  Date of birth of the customer.
  
  Example: "1993-12-31"
- tax_idstringmax length: 255
  An identification number user for tax purposes (e.g. CPF)
  
  Example: "423.378.593-47"
- addressAddress Legacy
  Profile's personal address information.
  
  Show attributes
  Close
  Address Legacy
  citystring
  City name from the address.
  
  Example: "Berlin"
  countrystring
  Two letter country code formatted according to ISO3166-1 alpha-2.
  
  Example: "DE"
  line_1string
  First line of the address with details of the street name and number.
  
  Example: "Sample street"
  line_2string
  Second line of the address with details of the building, unit, apartment, and floor numbers.
  
  Example: "ap. 5"
  postal_codestring
  Postal code from the address.
  
  Example: "10115"
  statestring
  State name or abbreviation from the address.
  
  Example: "Berlin"

1
{
2
  "customer_id": "831ff8d4cd5958ab5670",
3
  "personal_details": {
4
    "first_name": "John",
5
    "last_name": "Doe",
6
    "email": "user@example.com",
7
    "phone": "+491635559723",
8
    "birth_date": "1993-12-31",
9
    "tax_id": "423.378.593-47",
10
    "address": {
11
      "city": "Berlin",
12
      "country": "DE",
13
      "line_1": "Sample street",
14
      "line_2": "ap. 5",
15
      "postal_code": "10115",
16
      "state": "Berlin"
17
    }
18
  }
19
}

Customers

Create a customer

POST/v0.1/customers

Creates a new saved customer resource which you can later manipulate and save payment instruments to.

Required scopes:payment_instruments

Body Parameters

customer_idstringrequired
Unique ID of the customer.

Example: "831ff8d4cd5958ab5670"
personal_detailsPersonal Details
Personal details for the customer.
Show attributes
Close
Personal Details
- first_namestring
  First name of the customer.
  
  Example: "John"
- last_namestring
  Last name of the customer.
  
  Example: "Doe"
- emailstring
  Email address of the customer.
  
  Example: "user@example.com"
- phonestring
  Phone number of the customer.
  
  Example: "+491635559723"
- birth_datestringformat: date
  Date of birth of the customer.
  
  Example: "1993-12-31"
- tax_idstringmax length: 255
  An identification number user for tax purposes (e.g. CPF)
  
  Example: "423.378.593-47"
- addressAddress Legacy
  Profile's personal address information.
  
  Show attributes
  Close
  Address Legacy
  citystring
  City name from the address.
  
  Example: "Berlin"
  countrystring
  Two letter country code formatted according to ISO3166-1 alpha-2.
  
  Example: "DE"
  line_1string
  First line of the address with details of the street name and number.
  
  Example: "Sample street"
  line_2string
  Second line of the address with details of the building, unit, apartment, and floor numbers.
  
  Example: "ap. 5"
  postal_codestring
  Postal code from the address.
  
  Example: "10115"
  statestring
  State name or abbreviation from the address.
  
  Example: "Berlin"

Response

Returns the customer resource. See Customer object.

customer_idstringrequired
Unique ID of the customer.

Example: "831ff8d4cd5958ab5670"
personal_detailsPersonal Details
Personal details for the customer.
Show attributes
Close
Personal Details
- first_namestring
  First name of the customer.
  
  Example: "John"
- last_namestring
  Last name of the customer.
  
  Example: "Doe"
- emailstring
  Email address of the customer.
  
  Example: "user@example.com"
- phonestring
  Phone number of the customer.
  
  Example: "+491635559723"
- birth_datestringformat: date
  Date of birth of the customer.
  
  Example: "1993-12-31"
- tax_idstringmax length: 255
  An identification number user for tax purposes (e.g. CPF)
  
  Example: "423.378.593-47"
- addressAddress Legacy
  Profile's personal address information.
  
  Show attributes
  Close
  Address Legacy
  citystring
  City name from the address.
  
  Example: "Berlin"
  countrystring
  Two letter country code formatted according to ISO3166-1 alpha-2.
  
  Example: "DE"
  line_1string
  First line of the address with details of the street name and number.
  
  Example: "Sample street"
  line_2string
  Second line of the address with details of the building, unit, apartment, and floor numbers.
  
  Example: "ap. 5"
  postal_codestring
  Postal code from the address.
  
  Example: "10115"
  statestring
  State name or abbreviation from the address.
  
  Example: "Berlin"

1
curl https://api.sumup.com/v0.1/customers \
2
 -X POST \
3
 -H "Authorization: Bearer $SUMUP_API_KEY" \
4
 --json '{
5
    "customer_id": "831ff8d4cd5958ab5670"
6
  }'

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.customers.create({
6
  customer_id: "831ff8d4cd5958ab5670",
7
});

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Customers.CreateAsync(
6
    new Customer
7
    {
8
        CustomerId = "831ff8d4cd5958ab5670",
9
    }
10
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.customers().createCustomer(
6
  Customer.builder()
7
    .customerId("831ff8d4cd5958ab5670")
8
    .build()
9
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.customers.create(CreateCustomerBody(
6
  customer_id="831ff8d4cd5958ab5670",
7
))

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->customers->create([
4
  'customer_id' => '831ff8d4cd5958ab5670',
5
]);

1
client := sumup.NewClient()
2

3
result, err := client.Customers.Create(context.Background(), sumup.CustomersCreateParams{
4
  CustomerId: "831ff8d4cd5958ab5670",
5
})

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.customers().create(sumup::CreateCustomerBody{
6
  customer_id: "831ff8d4cd5958ab5670".to_string(),
7
}).await;

1
{
2
  "customer_id": "831ff8d4cd5958ab5670",
3
  "personal_details": {
4
    "first_name": "John",
5
    "last_name": "Doe",
6
    "email": "user@example.com",
7
    "phone": "+491635559723",
8
    "birth_date": "1993-12-31",
9
    "tax_id": "423.378.593-47",
10
    "address": {
11
      "city": "Berlin",
12
      "country": "DE",
13
      "line_1": "Sample street",
14
      "line_2": "ap. 5",
15
      "postal_code": "10115",
16
      "state": "Berlin"
17
    }
18
  }
19
}

Content-Type: application/json

The request body is invalid.

Content-Type: application/json

The request is not authorized.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Content-Type: application/json

The request is authenticated but not permitted for this operation.

error_messagestring
Short description of the error.

Example: "request_not_allowed"
error_codestring
Platform code for the error.

Example: "FORBIDDEN"
status_codestring
HTTP status code for the error.

Example: "403"

Content-Type: application/json

A customer with the provided identifier already exists.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

1
{
2
  "error_code": "INVALID",
3
  "message": "Validation error",
4
  "param": "customer_id"
5
}

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}

1
{
2
  "error_message": "request_not_allowed",
3
  "error_code": "FORBIDDEN",
4
  "status_code": "403"
5
}

1
{
2
  "message": "Customer already exists",
3
  "error_code": "CUSTOMER_ALREADY_EXISTS"
4
}

Customers

Retrieve a customer

GET/v0.1/customers/{customer_id}

Retrieves an identified saved customer resource through the unique customer_id parameter, generated upon customer creation.

Required scopes:payment_instruments

Path Parameters

customer_idstringrequired
Unique ID of the saved customer resource.

Response

Returns the customer resource. See Customer object.

customer_idstringrequired
Unique ID of the customer.

Example: "831ff8d4cd5958ab5670"
personal_detailsPersonal Details
Personal details for the customer.
Show attributes
Close
Personal Details
- first_namestring
  First name of the customer.
  
  Example: "John"
- last_namestring
  Last name of the customer.
  
  Example: "Doe"
- emailstring
  Email address of the customer.
  
  Example: "user@example.com"
- phonestring
  Phone number of the customer.
  
  Example: "+491635559723"
- birth_datestringformat: date
  Date of birth of the customer.
  
  Example: "1993-12-31"
- tax_idstringmax length: 255
  An identification number user for tax purposes (e.g. CPF)
  
  Example: "423.378.593-47"
- addressAddress Legacy
  Profile's personal address information.
  
  Show attributes
  Close
  Address Legacy
  citystring
  City name from the address.
  
  Example: "Berlin"
  countrystring
  Two letter country code formatted according to ISO3166-1 alpha-2.
  
  Example: "DE"
  line_1string
  First line of the address with details of the street name and number.
  
  Example: "Sample street"
  line_2string
  Second line of the address with details of the building, unit, apartment, and floor numbers.
  
  Example: "ap. 5"
  postal_codestring
  Postal code from the address.
  
  Example: "10115"
  statestring
  State name or abbreviation from the address.
  
  Example: "Berlin"

1
curl https://api.sumup.com/v0.1/customers/{customer_id} \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.customers.get("customer_id");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Customers.GetAsync(
6
    "customer_id"
7
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.customers().getCustomer(
6
  "customer_id"
7
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.customers.get("customer_id")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->customers->get('customer_id');

1
client := sumup.NewClient()
2

3
result, err := client.Customers.Get(context.Background(), "customer_id")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.customers().get("customer_id").await;

1
{
2
  "customer_id": "831ff8d4cd5958ab5670",
3
  "personal_details": {
4
    "first_name": "John",
5
    "last_name": "Doe",
6
    "email": "user@example.com",
7
    "phone": "+491635559723",
8
    "birth_date": "1993-12-31",
9
    "tax_id": "423.378.593-47",
10
    "address": {
11
      "city": "Berlin",
12
      "country": "DE",
13
      "line_1": "Sample street",
14
      "line_2": "ap. 5",
15
      "postal_code": "10115",
16
      "state": "Berlin"
17
    }
18
  }
19
}

Content-Type: application/json

The request is not authorized.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Content-Type: application/json

The request is authenticated but not permitted for this operation.

error_messagestring
Short description of the error.

Example: "request_not_allowed"
error_codestring
Platform code for the error.

Example: "FORBIDDEN"
status_codestring
HTTP status code for the error.

Example: "403"

Content-Type: application/json

The requested resource does not exist.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}

1
{
2
  "error_message": "request_not_allowed",
3
  "error_code": "FORBIDDEN",
4
  "status_code": "403"
5
}

1
{
2
  "error_code": "NOT_FOUND",
3
  "message": "Resource not found"
4
}

Customers

Update a customer

PUT/v0.1/customers/{customer_id}

Updates an identified saved customer resource's personal details.

The request only overwrites the parameters included in the request, all other parameters will remain with their initially assigned values.

Required scopes:payment_instruments

Path Parameters

customer_idstringrequired
Unique ID of the saved customer resource.

Body Parameters

personal_detailsPersonal Details
Personal details for the customer.
Show attributes
Close
Personal Details
- first_namestring
  First name of the customer.
  
  Example: "John"
- last_namestring
  Last name of the customer.
  
  Example: "Doe"
- emailstring
  Email address of the customer.
  
  Example: "user@example.com"
- phonestring
  Phone number of the customer.
  
  Example: "+491635559723"
- birth_datestringformat: date
  Date of birth of the customer.
  
  Example: "1993-12-31"
- tax_idstringmax length: 255
  An identification number user for tax purposes (e.g. CPF)
  
  Example: "423.378.593-47"
- addressAddress Legacy
  Profile's personal address information.
  
  Show attributes
  Close
  Address Legacy
  citystring
  City name from the address.
  
  Example: "Berlin"
  countrystring
  Two letter country code formatted according to ISO3166-1 alpha-2.
  
  Example: "DE"
  line_1string
  First line of the address with details of the street name and number.
  
  Example: "Sample street"
  line_2string
  Second line of the address with details of the building, unit, apartment, and floor numbers.
  
  Example: "ap. 5"
  postal_codestring
  Postal code from the address.
  
  Example: "10115"
  statestring
  State name or abbreviation from the address.
  
  Example: "Berlin"

Response

Returns the customer resource. See Customer object.

customer_idstringrequired
Unique ID of the customer.

Example: "831ff8d4cd5958ab5670"
personal_detailsPersonal Details
Personal details for the customer.
Show attributes
Close
Personal Details
- first_namestring
  First name of the customer.
  
  Example: "John"
- last_namestring
  Last name of the customer.
  
  Example: "Doe"
- emailstring
  Email address of the customer.
  
  Example: "user@example.com"
- phonestring
  Phone number of the customer.
  
  Example: "+491635559723"
- birth_datestringformat: date
  Date of birth of the customer.
  
  Example: "1993-12-31"
- tax_idstringmax length: 255
  An identification number user for tax purposes (e.g. CPF)
  
  Example: "423.378.593-47"
- addressAddress Legacy
  Profile's personal address information.
  
  Show attributes
  Close
  Address Legacy
  citystring
  City name from the address.
  
  Example: "Berlin"
  countrystring
  Two letter country code formatted according to ISO3166-1 alpha-2.
  
  Example: "DE"
  line_1string
  First line of the address with details of the street name and number.
  
  Example: "Sample street"
  line_2string
  Second line of the address with details of the building, unit, apartment, and floor numbers.
  
  Example: "ap. 5"
  postal_codestring
  Postal code from the address.
  
  Example: "10115"
  statestring
  State name or abbreviation from the address.
  
  Example: "Berlin"

1
curl https://api.sumup.com/v0.1/customers/{customer_id} \
2
 -X PUT \
3
 -H "Authorization: Bearer $SUMUP_API_KEY" \
4
 --json '{}'

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.customers.update("customer_id", {
6

7
});

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Customers.UpdateAsync(
6
    "customer_id",
7
    new UpdateCustomerBody
8
    {
9

10
    }
11
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.customers().updateCustomer(
6
  "customer_id",
7
  UpdateCustomerBody.builder()
8

9
    .build()
10
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.customers.update("customer_id", UpdateCustomerBody(
6

7
))

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->customers->update('customer_id', [
4

5
]);

1
client := sumup.NewClient()
2

3
result, err := client.Customers.Update(context.Background(), "customer_id", sumup.CustomersUpdateParams{
4

5
})

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.customers().update("customer_id", sumup::UpdateCustomerBody{}).await;

1
{
2
  "customer_id": "831ff8d4cd5958ab5670",
3
  "personal_details": {
4
    "first_name": "John",
5
    "last_name": "Doe",
6
    "email": "user@example.com",
7
    "phone": "+491635559723",
8
    "birth_date": "1993-12-31",
9
    "tax_id": "423.378.593-47",
10
    "address": {
11
      "city": "Berlin",
12
      "country": "DE",
13
      "line_1": "Sample street",
14
      "line_2": "ap. 5",
15
      "postal_code": "10115",
16
      "state": "Berlin"
17
    }
18
  }
19
}

Content-Type: application/json

The request is not authorized.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Content-Type: application/json

The request is authenticated but not permitted for this operation.

error_messagestring
Short description of the error.

Example: "request_not_allowed"
error_codestring
Platform code for the error.

Example: "FORBIDDEN"
status_codestring
HTTP status code for the error.

Example: "403"

Content-Type: application/json

The requested resource does not exist.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}

1
{
2
  "error_message": "request_not_allowed",
3
  "error_code": "FORBIDDEN",
4
  "status_code": "403"
5
}

1
{
2
  "error_code": "NOT_FOUND",
3
  "message": "Resource not found"
4
}

Customers

List payment instruments

GET/v0.1/customers/{customer_id}/payment-instruments

Lists all payment instrument resources that are saved for an identified customer.

Required scopes:payment_instruments

Path Parameters

customer_idstringrequired
Unique ID of the saved customer resource.

Response

Returns the list of saved payment instruments for the customer.

[]PaymentInstrumentResponse

Show attributes

tokenstringRead only
Unique token identifying the saved payment card for a customer.
activebooleandefault: true, Read only
Indicates whether the payment instrument is active and can be used for payments. To deactivate it, send a DELETE request to the resource endpoint.
typestring
Options: card
Type of the payment instrument.
cardobject
Details of the payment card.
Show attributes
Close
Attributes
- last_4_digitsstringmin length: 4, max length: 4, Read only
  Last 4 digits of the payment card number.
  
  Example: "3456"
- typeCard Type
  Options: ALELOAMEXCONECSCUPDINERSDISCOVEREFTPOSELOELVGIROCARDHIPERCARDINTERACJCBMAESTROMASTERCARDPLUXEESWILETICKETVISAVISA_ELECTRONVISA_VPAYVPAYVRUNKNOWN
  Issuing card network of the payment card used for the transaction.
mandateMandate Response
Details of the mandate linked to the saved payment instrument.
Show attributes
Close
Mandate Response
- typestring
  Type of mandate stored for the checkout or payment instrument.
- statusstring
  Options: activeinactive
  Current lifecycle status of the mandate.
  
  Example: "active"
- merchant_codestring
  Merchant account for which the mandate is valid.
  
  Example: "MH4H92C7"
Example: {"type":"recurrent","status":"active","merchant_code":"MH4H92C7"}
created_atstringformat: date-time
Creation date of payment instrument. Response format expressed according to ISO8601 code.

1
curl https://api.sumup.com/v0.1/customers/{customer_id}/payment-instruments \
2
 -X GET \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.customers.listPaymentInstruments("customer_id");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Customers.ListPaymentInstrumentsAsync(
6
    "customer_id"
7
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.customers().listPaymentInstruments(
6
  "customer_id"
7
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.customers.list_payment_instruments("customer_id")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->customers->listPaymentInstruments('customer_id');

1
client := sumup.NewClient()
2

3
result, err := client.Customers.ListPaymentInstruments(context.Background(), "customer_id")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.customers().list_payment_instruments("customer_id").await;

1
[
2
  {
3
    "token": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3",
4
    "active": true,
5
    "type": "card",
6
    "mandate": {
7
      "type": "recurrent",
8
      "status": "active",
9
      "merchant_code": "MH4H92C7"
10
    },
11
    "card": {
12
      "last_4_digits": "0001",
13
      "type": "VISA"
14
    },
15
    "created_at": "2021-03-30T10:06:07.000+00:00"
16
  }
17
]

Content-Type: application/json

The request is not authorized.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Content-Type: application/json

The request is authenticated but not permitted for this operation.

error_messagestring
Short description of the error.

Example: "request_not_allowed"
error_codestring
Platform code for the error.

Example: "FORBIDDEN"
status_codestring
HTTP status code for the error.

Example: "403"

Content-Type: application/json

The requested resource does not exist.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}

1
{
2
  "error_message": "request_not_allowed",
3
  "error_code": "FORBIDDEN",
4
  "status_code": "403"
5
}

1
{
2
  "error_code": "NOT_FOUND",
3
  "message": "Resource not found"
4
}

Customers

Deactivate a payment instrument

DELETE/v0.1/customers/{customer_id}/payment-instruments/{token}

Deactivates an identified card payment instrument resource for a customer.

Required scopes:payment_instruments

Path Parameters

customer_idstringrequired
Unique ID of the saved customer resource.
tokenstringrequired
Unique token identifying the card saved as a payment instrument resource.

Response

Returns empty response.

1
curl https://api.sumup.com/v0.1/customers/{customer_id}/payment-instruments/{token} \
2
 -X DELETE \
3
 -H "Authorization: Bearer $SUMUP_API_KEY"

1
import SumUp from '@sumup/sdk';
2

3
const client = new SumUp();
4

5
const result = await client.customers.deactivatePaymentInstrument("customer_id", "token");

1
using SumUp;
2

3
var client = new SumUpClient();
4

5
var result = await client.Customers.DeactivatePaymentInstrumentAsync(
6
    "customer_id",
7
    "token"
8
);

1
import com.sumup.sdk.SumUpClient;
2

3
SumUpClient client = SumUpClient.builder().build();
4

5
var result = client.customers().deactivatePaymentInstrument(
6
  "customer_id",
7
  "token"
8
);

1
from sumup import Sumup
2

3
client = Sumup()
4

5
result = client.customers.deactivate_payment_instrument("customer_id", "token")

1
$sumup = new \SumUp\SumUp();
2

3
$result = $sumup->customers->deactivatePaymentInstrument('customer_id', 'token');

1
client := sumup.NewClient()
2

3
result, err := client.Customers.DeactivatePaymentInstrument(context.Background(), "customer_id", "token")

1
use sumup::Client;
2

3
let client = Client::default();
4

5
let result = client.customers().deactivate_payment_instrument("customer_id", "token").await;

Content-Type: application/json

The request is invalid.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

Content-Type: application/json

The request is not authorized.

typestringrequiredformat: uri
A URI reference that identifies the problem type.

Example: "https://developer.sumup.com/problem/not-found"
titlestring
A short, human-readable summary of the problem type.

Example: "Requested resource couldn't be found."
statusinteger
The HTTP status code generated by the origin server for this occurrence of the problem.

Example: 404
detailstring
A human-readable explanation specific to this occurrence of the problem.

Example: "The requested resource doesn't exist or does not belong to you."
instancestringformat: uri
A URI reference that identifies the specific occurrence of the problem.

Content-Type: application/json

The request is authenticated but not permitted for this operation.

error_messagestring
Short description of the error.

Example: "request_not_allowed"
error_codestring
Platform code for the error.

Example: "FORBIDDEN"
status_codestring
HTTP status code for the error.

Example: "403"

Content-Type: application/json

The requested resource does not exist.

messagestring
Short description of the error.

Example: "Resource not found"
error_codestring
Platform code for the error.

Example: "NOT_FOUND"

1
{
2
  "error_code": "INVALID_REQUEST",
3
  "message": "bad request"
4
}

1
{
2
  "detail": "Unauthorized.",
3
  "status": 401,
4
  "title": "Unauthorized",
5
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
6
  "type": "https://developer.sumup.com/problem/unauthorized"
7
}

1
{
2
  "error_message": "request_not_allowed",
3
  "error_code": "FORBIDDEN",
4
  "status_code": "403"
5
}

1
{
2
  "error_code": "NOT_FOUND",
3
  "message": "Resource not found"
4
}