Get Sandbox Access

Paybase Developer Centre

OverviewAPI GuidesGetting StartedRecipesGig Economy PlatformsSharing Economy PlatformsMarketplacesBlockchain BusinessesEscrowRolesRulesDue DiligenceCustomersAccountsBank AccountsCardsTransactionsIntroductionInboundGetting money into the systemTransaction ReferenceAccount ReferenceInternalOutboundEscrowSplit PaymentsRefundsStrong Customer Authentication3D Secure AuthenticationIntroductionCreate a cardCreate a transactionDocument UploadStatementsWebhooksErrorsPQLAPI ReferenceAccountCreate an accountRetrieve an accountTransition account statusList all accountsAnnotate an accountDelete annotation from an accountTag an accountDelete tag from an accountBank AccountCreate a bank accountRetrieve a bank accountUpdate a bank accountTransition bank account statusList all bank accountsAnnotate a bank accountDelete annotation from a bank accountTag a bank accountDelete tag from a bank accountCardCreate a cardRetrieve a cardUpdate a cardTransition card statusList all cardsAnnotate a cardDelete annotation from a cardTag a cardDelete tag from a cardCardholderCreate a cardholderRetrieve a cardholderUpdate a cardholderTransition cardholder statusList all cardholdersAnnotate a cardholderDelete annotation from a cardholderTag a cardholderDelete tag from a cardholderCreate an authentication tokenCheckCreate a checkCustomerIndividual CustomerCreate a customerRetrieve a customerUpdate a customerSole TraderCreate a customerRetrieve a customerUpdate a customerOrganisationCreate a CustomerRetrieve a CustomerUpdate a CustomerIncorporated BusinessCreate a customerRetrieve a customerUpdate a customerBusiness PersonAdd a business personRetrieve a business personUpdate a business personDelete a business personRetrieve a customerTransition state of a customerList all customersAnnotate a customerDelete annotation from a customerTag a customerRemove tag from a customerCreate an authentication tokenTouch a customerDocumentCreate a documentRetrieve a documentList Document TypesReferenceRetrieve a referenceStatementRetrieve a statementStatusRetrieve API statusTransactionCreate inbound transactionCreate internal transactionCreate outbound transactionRetrieve a transactionTransition transaction statusList all transactionsAnnotate a transactionDelete annotation from a transactionTag a transactionDelete tag from a transaction
API version: 7c99a7a

Delete tag from a cardholderDELETE/v1/cardholder/{id}/tags

1
2
3
4
5
6
7
8
9
10
import { v1 } from '@paybase/client';

const client = v1('<- API Key ->', { sandbox: true });

const result = await client.untagCardholder({
  id: "cardholder/28958679-e8a8-47a8-967c-f979ae8509a2",
  tags: [
    42
  ]
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import json
import requests

requests.delete(
  "https://api-json.sandbox.paybase.io/v1/cardholder/cardholder/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/tags",
  data = json.dumps({
    tags: [
      42
    ]
  }),
  headers = {
    Content-Type: "application/json",
    X-Token: "<X-Token goes here>"
  }
).json()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
$client = new \GuzzleHttp\Client();
$client->request(
  "delete",
  "https://api-json.sandbox.paybase.io/v1/cardholder/cardholder/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/tags",
  [
    "body" => "{
      tags: [
        42
      ]
    }",
    "headers" => [
      "Content-Type" => "application/json",
      "X-Token" => "<X-Token goes here>",
    ]
  ]
);

1
2
3
4
5
6
7
8
9
curl -X DELETE \
"https://api-json.sandbox.paybase.io/v1/cardholder/cardholder/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/tags"  -H "Content-Type: application/json" \
  -H "X-Token: <X-Token goes here>" \
  -d '{
    tags: [
      42
    ]
  }'

Request

FieldDescription
idURI Param
string

The unique identifier of the entity.

Format

_entity_/_uuid_

e.g. card/62dc1d23-d473-46a6-b4b3-e63c3f6d4658 or account/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

tagsrequired
array<string>

Array of tags you want delete.

Response

FieldDescription
id
string

The unique identifier of the cardholder.

Format

cardholder/_uuid_

e.g. cardholder/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

fullName
string

The full name of the cardholder.

email
string

The email address of the cardholder.

Email address is one of the parameters we use to determine if a cardholder is unique.

terms.acceptedAt
date

The timestamp in UTC at which the Terms were accepted.

terms.revision
string

Version name or number of the Terms that were accepted.

type
enum

Whether the card is held by an individual or a company.

enum

INDIVIDUAL, COMPANY,

If left empty, the value will default to UNKNOWN

roleId
string

The unique identifier of the role.

Format

role/_uuid_

e.g. role/62dc1d23-d473-46a6-b4b3-e63c3f6d4658

stateId
enum

The current state of the cardholder.

enum

PENDING, ENABLED, DISABLED, CLOSED

tags
array<string>

An array of string values. Tags can be attached to objects in order to drive rules based logic either on Paybase or on your own system.

annotations
object<string, string>

A hash map of key value pairs. Annotations allow you to supply information which is pertinent to your own system (e.g. Providing the ID of a customer on your system to link to their Paybase account). Annotations can also drive various Paybase rules.