Get Sandbox Access

Paybase Developer Centre

OverviewAPI GuidesGetting StartedRecipesGig Economy PlatformsSharing Economy PlatformsMarketplacesBlockchain BusinessesEscrowSandboxRolesRulesDue 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: ba085a6

Delete annotation from a cardDELETE/v1/card/{id}/annotations

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.unannotateCard({
  id: "card/28958679-e8a8-47a8-967c-f979ae8509a2",
  keys: [
    everything
  ]
});

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/card/card/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/annotations",
  data = json.dumps({
    "keys": [
      "everything"
    ]
  }),
  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/card/card/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/annotations",
  [
    "body" => "{
      \"keys\": [
        \"everything\"
      ]
    }",
    "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/card/card/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/annotations"  -H "Content-Type: application/json" \
  -H "X-Token: <X-Token goes here>" \
  -d '{
    "keys": [
      "everything"
    ]
  }'

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

keysrequired
array<string>

An array of annotation key values.

Response

FieldDescription
id
string

The unique identifier of the card object.

Format

card/_uuid_

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

createdAt
date

The timestamp in UTC at which the card was created.

updatedAt
date

The timestamp in UTC at which the card was last updated.

stateId
enum

The state of the card. The actions that can be performed on a card will depend on its stateId.

enum

PENDING, PROCESSING, FAILED, ENABLED, INACTIVE, DISABLED, CLOSED

A DISABLED card can only be ENABLED by Paybase.

Once CLOSED, a card cannot be ENABLED again.

cardNumberSuffix
string

Last four digits of the card number.

expiry
string

Expiry date of the card.

Format

MMYY e.g. 0219

scheme
string

Scheme of the card.

enum

VISA, MASTERCARD

type
string

Type of the card.

enum

debit, credit, unknown

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.

ownerId
string

The id of the Customer that owns the card.

Format

customer/_uuid_

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

billingAddress.flatNumber
string

Flat number.

billingAddress.houseNameNumber
string

House name or number. If the address has both, include both in the string.

billingAddress.street
string

Street name.

billingAddress.townCity
string

Town or city.

billingAddress.region
string

Region/County/State/Province.

billingAddress.postalCode
string

Postal Code or ZIP.

billingAddress.countryISO
string

Country code

Format

Two-letter ISO 3166-1 alpha-2 code.

e.g. GB

storageType
enum

Defines whether a card is for single use or should be tokenised and stored on file for future use.

enum

CARD_ON_FILE, ONE_TIME_USE

setAsPreferred
bool

Set this attribute to true to use the specified card as the default card to use for a Customer.

requirements
object<string, string>

A map of further authentication requirements for successfully creating the card.

The card will remain in PROCESSING status until these requirements have been resolved.