SumUpDeveloper
Dashboard

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.

Endpoints

The Customer object

Saved customer details.

  • customer_idstringrequired

    Unique identifier 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

      Identification number used for tax purposes, such as a CPF in Brazil.

      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"
The Customer object
{
  "customer_id": "831ff8d4cd5958ab5670",
  "personal_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "user@example.com",
    "phone": "+491635559723",
    "birth_date": "1993-12-31",
    "tax_id": "423.378.593-47",
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line_1": "Sample street",
      "line_2": "ap. 5",
      "postal_code": "10115",
      "state": "Berlin"
    }
  }
}
Customers

Create a customer

POST/v0.1/customers

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

Requires one of scopes:payment_instrumentscustomers.write

Body Parameters

  • customer_idstringrequired

    Unique identifier 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

      Identification number used for tax purposes, such as a CPF in Brazil.

      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 identifier 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

      Identification number used for tax purposes, such as a CPF in Brazil.

      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"
POST/v0.1/customers
curl https://api.sumup.com/v0.1/customers \
 -X POST \
 -H "Authorization: Bearer $SUMUP_API_KEY" \
 --json '{
    "customer_id": "831ff8d4cd5958ab5670"
  }'
import SumUp from '@sumup/sdk';

const client = new SumUp();

const result = await client.customers.create({
  customer_id: "831ff8d4cd5958ab5670",
});
using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Customers.CreateAsync(
            JsonSerializer.Deserialize<Customer>(@"{""customer_id"":""831ff8d4cd5958ab5670""}")!);

        Console.WriteLine(response.StatusCode);
    }
}
import com.sumup.sdk.SumUpClient;

public final class CreateCustomerSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    var result = client.customers().create(
            com.sumup.sdk.models.Customer.builder()
                .customerId("831ff8d4cd5958ab5670")
                .build()
        );
    System.out.println(result);
  }
}
import os

import sumup


def main() -> None:
    client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])

    result = client.customers.create(
        customer_id="831ff8d4cd5958ab5670",
    )
    print(result)


if __name__ == "__main__":
    main()
<?php

$sumup = new \SumUp\SumUp();

$result = $sumup->customers->create([
  'customer_id' => '831ff8d4cd5958ab5670',
]);
package main

import (
	"context"
	"log"

	"github.com/sumup/sumup-go"
)

func main() {
	ctx := context.Background()
	client := sumup.NewClient()

	result, err := client.Customers.Create(ctx, sumup.CustomersCreateParams{
		CustomerID: "831ff8d4cd5958ab5670",
	})
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("%+v", result)
}
use sumup::Client;

let client = Client::default();

let result = client.customers().create(sumup::CreateCustomerBody{
  customer_id: "831ff8d4cd5958ab5670".to_string(),
}).await;
Create a customer response
{
  "customer_id": "831ff8d4cd5958ab5670",
  "personal_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "user@example.com",
    "phone": "+491635559723",
    "birth_date": "1993-12-31",
    "tax_id": "423.378.593-47",
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line_1": "Sample street",
      "line_2": "ap. 5",
      "postal_code": "10115",
      "state": "Berlin"
    }
  }
}

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.

      Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

    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"
    Error 400
    {
  "error_code": "INVALID",
  "message": "Validation error",
  "param": "customer_id"
}
    Error 401
    {
  "detail": "Unauthorized.",
  "status": 401,
  "title": "Unauthorized",
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
  "type": "https://developer.sumup.com/problem/unauthorized"
}
    Error 403
    {
  "error_message": "request_not_allowed",
  "error_code": "FORBIDDEN",
  "status_code": "403"
}
    Error 409
    {
  "message": "Customer already exists",
  "error_code": "CUSTOMER_ALREADY_EXISTS"
}
    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.

    Requires one of scopes:payment_instrumentscustomers.read

    Path Parameters

    • customer_idstringrequired

      Unique identifier of the saved customer resource.

      Example: "831ff8d4cd5958ab5670"

    Response

    Returns the customer resource. See Customer object.

    • customer_idstringrequired

      Unique identifier 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

        Identification number used for tax purposes, such as a CPF in Brazil.

        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"
    GET/v0.1/customers/{customer_id}
    curl https://api.sumup.com/v0.1/customers/{customer_id} \
 -X GET \
 -H "Authorization: Bearer $SUMUP_API_KEY"
    import SumUp from '@sumup/sdk';

const client = new SumUp();

const result = await client.customers.get("831ff8d4cd5958ab5670");
    using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Customers.GetAsync(
            "example-id");

        Console.WriteLine(response.StatusCode);
    }
}
    import com.sumup.sdk.SumUpClient;

public final class GetCustomerSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    var result = client.customers().get(
            "example"
        );
    System.out.println(result);
  }
}
    import os

import sumup


def main() -> None:
    client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])

    result = client.customers.get(
        "string",
    )
    print(result)


if __name__ == "__main__":
    main()
    <?php

$sumup = new \SumUp\SumUp();

$result = $sumup->customers->get('831ff8d4cd5958ab5670');
    package main

import (
	"context"
	"log"

	"github.com/sumup/sumup-go"
)

func main() {
	ctx := context.Background()
	client := sumup.NewClient()

	result, err := client.Customers.Get(ctx, "string")
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("%+v", result)
}
    use sumup::Client;

let client = Client::default();

let result = client.customers().get("831ff8d4cd5958ab5670").await;
    Retrieve a customer response
    {
  "customer_id": "831ff8d4cd5958ab5670",
  "personal_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "user@example.com",
    "phone": "+491635559723",
    "birth_date": "1993-12-31",
    "tax_id": "423.378.593-47",
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line_1": "Sample street",
      "line_2": "ap. 5",
      "postal_code": "10115",
      "state": "Berlin"
    }
  }
}

    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.

      Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

    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"
    Error 401
    {
  "detail": "Unauthorized.",
  "status": 401,
  "title": "Unauthorized",
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
  "type": "https://developer.sumup.com/problem/unauthorized"
}
    Error 403
    {
  "error_message": "request_not_allowed",
  "error_code": "FORBIDDEN",
  "status_code": "403"
}
    Error 404
    {
  "error_code": "NOT_FOUND",
  "message": "Resource not found"
}
    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.

    Requires one of scopes:payment_instrumentscustomers.write

    Path Parameters

    • customer_idstringrequired

      Unique identifier of the saved customer resource.

      Example: "831ff8d4cd5958ab5670"

    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

        Identification number used for tax purposes, such as a CPF in Brazil.

        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 identifier 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

        Identification number used for tax purposes, such as a CPF in Brazil.

        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"
    PUT/v0.1/customers/{customer_id}
    curl https://api.sumup.com/v0.1/customers/{customer_id} \
 -X PUT \
 -H "Authorization: Bearer $SUMUP_API_KEY" \
 --json '{}'
    import SumUp from '@sumup/sdk';

const client = new SumUp();

const result = await client.customers.update("831ff8d4cd5958ab5670", {

});
    using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Customers.UpdateAsync(
            "example-id",
            JsonSerializer.Deserialize<CustomersUpdateRequest>(@"{}")!);

        Console.WriteLine(response.StatusCode);
    }
}
    import com.sumup.sdk.SumUpClient;

public final class UpdateCustomerSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    var result = client.customers().update(
            "example",
            com.sumup.sdk.models.UpdateCustomerRequest.builder()
                .build()
        );
    System.out.println(result);
  }
}
    import os

import sumup


def main() -> None:
    client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])

    result = client.customers.update(
        "string",
    )
    print(result)


if __name__ == "__main__":
    main()
    <?php

$sumup = new \SumUp\SumUp();

$result = $sumup->customers->update('831ff8d4cd5958ab5670', [

]);
    package main

import (
	"context"
	"log"

	"github.com/sumup/sumup-go"
)

func main() {
	ctx := context.Background()
	client := sumup.NewClient()

	result, err := client.Customers.Update(ctx, "string", sumup.CustomersUpdateParams{})
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("%+v", result)
}
    use sumup::Client;

let client = Client::default();

let result = client.customers().update("831ff8d4cd5958ab5670", sumup::UpdateCustomerBody{}).await;
    Update a customer response
    {
  "customer_id": "831ff8d4cd5958ab5670",
  "personal_details": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "user@example.com",
    "phone": "+491635559723",
    "birth_date": "1993-12-31",
    "tax_id": "423.378.593-47",
    "address": {
      "city": "Berlin",
      "country": "DE",
      "line_1": "Sample street",
      "line_2": "ap. 5",
      "postal_code": "10115",
      "state": "Berlin"
    }
  }
}

    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.

      Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

    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"
    Error 401
    {
  "detail": "Unauthorized.",
  "status": 401,
  "title": "Unauthorized",
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
  "type": "https://developer.sumup.com/problem/unauthorized"
}
    Error 403
    {
  "error_message": "request_not_allowed",
  "error_code": "FORBIDDEN",
  "status_code": "403"
}
    Error 404
    {
  "error_code": "NOT_FOUND",
  "message": "Resource not found"
}
    Customers

    List payment instruments

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

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

    Requires one of scopes:payment_instrumentscustomers.read

    Path Parameters

    • customer_idstringrequired

      Unique identifier of the saved customer resource.

      Example: "831ff8d4cd5958ab5670"

    Response

    Returns the list of saved payment instruments for the customer.

    []PaymentInstrumentResponse
     Show attributes
     Close
    Payment Instrument Response
    • tokenstringRead only

      Unique token identifying the saved payment card for a customer.

      Example: "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3"
    • 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.

      Example: "card"
    • 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.

        Example: "VISA"
    • 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.

        Example: "recurrent"
      • statusstring
        Options: activeinactive

        Current lifecycle status of the mandate.

        Example: "active"
      • merchant_codestring

        Short unique identifier for the merchant for which the mandate is valid.

        Example: "MH4H92C7"
      Example: {"type":"recurrent","status":"active","merchant_code":"MH4H92C7"}
    • created_atstringformat: date-time

      The timestamp of when the payment instrument was created.

      Example: "2021-03-30T10:06:07.000+00:00"
      GET/v0.1/customers/{customer_id}/payment-instruments
      curl https://api.sumup.com/v0.1/customers/{customer_id}/payment-instruments \
 -X GET \
 -H "Authorization: Bearer $SUMUP_API_KEY"
      import SumUp from '@sumup/sdk';

const client = new SumUp();

const result = await client.customers.listPaymentInstruments("831ff8d4cd5958ab5670");
      using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Customers.ListPaymentInstrumentsAsync(
            "example-id");

        Console.WriteLine(response.StatusCode);
    }
}
      import com.sumup.sdk.SumUpClient;

public final class ListPaymentInstrumentsSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    var result = client.customers().listPaymentInstruments(
            "example"
        );
    System.out.println(result);
  }
}
      import os

import sumup


def main() -> None:
    client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])

    result = client.customers.list_payment_instruments(
        "string",
    )
    print(result)


if __name__ == "__main__":
    main()
      <?php

$sumup = new \SumUp\SumUp();

$result = $sumup->customers->listPaymentInstruments('831ff8d4cd5958ab5670');
      package main

import (
	"context"
	"log"

	"github.com/sumup/sumup-go"
)

func main() {
	ctx := context.Background()
	client := sumup.NewClient()

	result, err := client.Customers.ListPaymentInstruments(ctx, "string")
	if err != nil {
		log.Fatal(err)
	}

	log.Printf("%+v", result)
}
      use sumup::Client;

let client = Client::default();

let result = client.customers().list_payment_instruments("831ff8d4cd5958ab5670").await;
      List payment instruments response
      [
  {
    "token": "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3",
    "active": true,
    "type": "card",
    "mandate": {
      "type": "recurrent",
      "status": "active",
      "merchant_code": "MH4H92C7"
    },
    "card": {
      "last_4_digits": "0001",
      "type": "VISA"
    },
    "created_at": "2021-03-30T10:06:07.000+00:00"
  }
]

      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.

        Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

      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"
      Error 401
      {
  "detail": "Unauthorized.",
  "status": 401,
  "title": "Unauthorized",
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
  "type": "https://developer.sumup.com/problem/unauthorized"
}
      Error 403
      {
  "error_message": "request_not_allowed",
  "error_code": "FORBIDDEN",
  "status_code": "403"
}
      Error 404
      {
  "error_code": "NOT_FOUND",
  "message": "Resource not found"
}
      Customers

      Deactivate a payment instrument

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

      Deactivates an identified card payment instrument resource for a customer.

      Requires one of scopes:payment_instrumentscustomers.write

      Path Parameters

      • customer_idstringrequired

        Unique identifier of the saved customer resource.

        Example: "831ff8d4cd5958ab5670"
      • tokenstringrequired

        Unique token identifying the card saved as a payment instrument resource.

        Example: "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3"

      Response

      Returns empty response.

      DELETE/v0.1/customers/{customer_id}/payment-instruments/{token}
      curl https://api.sumup.com/v0.1/customers/{customer_id}/payment-instruments/{token} \
 -X DELETE \
 -H "Authorization: Bearer $SUMUP_API_KEY"
      import SumUp from '@sumup/sdk';

const client = new SumUp();

const result = await client.customers.deactivatePaymentInstrument("831ff8d4cd5958ab5670", "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3");
      using System;
using System.Collections.Generic;
using System.Text.Json;
using System.Threading.Tasks;
using SumUp;

public static class Program
{
    public static async Task Main()
    {
        using var client = new SumUpClient();
        var response = await client.Customers.DeactivatePaymentInstrumentAsync(
            "example-id",
            "example");

        Console.WriteLine(response.StatusCode);
    }
}
      import com.sumup.sdk.SumUpClient;

public final class DeactivatePaymentInstrumentSample {
  public static void main(String[] args) throws Exception {
    var client = new SumUpClient();

    client.customers().deactivatePaymentInstrument(
            "example",
            "example"
        );
  }
}
      import os

import sumup


def main() -> None:
    client = sumup.Sumup(api_key=os.environ["SUMUP_API_KEY"])

    client.customers.deactivate_payment_instrument(
        "string",
        "string",
    )


if __name__ == "__main__":
    main()
      <?php

$sumup = new \SumUp\SumUp();

$result = $sumup->customers->deactivatePaymentInstrument('831ff8d4cd5958ab5670', 'bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3');
      package main

import (
	"context"
	"log"

	"github.com/sumup/sumup-go"
)

func main() {
	ctx := context.Background()
	client := sumup.NewClient()

	if err := client.Customers.DeactivatePaymentInstrument(ctx, "string", "string"); err != nil {
		log.Fatal(err)
	}
}
      use sumup::Client;

let client = Client::default();

let result = client.customers().deactivate_payment_instrument("831ff8d4cd5958ab5670", "bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3").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.

        Example: "https://api.sumup.com/v0.1/checkouts/4e425463-3e1b-431d-83fa-1e51c2925e99"

      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"
      Error 400
      {
  "error_code": "INVALID_REQUEST",
  "message": "bad request"
}
      Error 401
      {
  "detail": "Unauthorized.",
  "status": 401,
  "title": "Unauthorized",
  "trace_id": "3c77294349d3b5647ea2d990f0d8f017",
  "type": "https://developer.sumup.com/problem/unauthorized"
}
      Error 403
      {
  "error_message": "request_not_allowed",
  "error_code": "FORBIDDEN",
  "status_code": "403"
}
      Error 404
      {
  "error_code": "NOT_FOUND",
  "message": "Resource not found"
}
      SumUpDeveloper

      Type to search…