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 tag from an accountDELETE/v1/account/{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.untagAccount({
  id: "account/28958679-e8a8-47a8-967c-f979ae8509a2",
  tags: [
    24
  ]
});

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

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 account object.

Format

account/_uuid_

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

createdAt
date

The timestamp in UTC at which the account was created.

updatedAt
date

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

activeAt
date

The timestamp in UTC at which the account was last active.

stateId
enum

The state of the account. The actions that an account can take will depend on its stateId.

enum

PENDING, ENABLED, DISABLED, CLOSED

Once CLOSED, an account cannot be ENABLED again.

ownerId
string

The id of the account owner. An account can be owned by a Customer or Tenant.

Format

_entity_/_uuid_

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

currencyISO
string

The currency in which the account will be held.

Format

Three-letter ISO 4217 code

e.g. GBP

completeBalance
string

The completeBalance of the account is the sum of all adjustments on every Transaction that is EFFECTED or ADJUSTED.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

availableBalance
string

The availableBalance of the account is the balance which can be debited from the account without any restrictions.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

availableBalance = completeBalance + incompleteDebits + disputedDebits - withheldBalance.

incompleteCredits
string

Credits expected on the account from transactions that have been initiated but not yet completed. Sum of all positive adjustments on every Transaction that is not EFFECTED or ADJUSTED.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

incompleteDebits
string

Debits expected on the account from transactions that have been initiated but not yet completed. Sum of all negative adjustments on every Transaction that is not EFFECTED or ADJUSTED. This excludes FEEs.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

disputedCredits
string

Sum of all positive adjustments on every Transaction that is DISPUTED.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

disputedDebits
string

Sum of all negative adjustments on every Transaction that is DISPUTED.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

feeDebits
string

Fees expected on the account from transactions that have been initiated but not yet completed. Sum of all FEE adjustments on every Transaction that is not EFFECTED or ADJUSTED.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

withheldBalance
string

Balance that is witheld on the account and cannot be debited for a certain period. Balances are witheld on accounts accepting card transactions and depend on your Reserve policy.

Format

Represented in the smallest currency unit. e.g. 1000 pennies for GBP 10

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.

type
enum

The type of currency in which the account is held. Accounts can hold real money balances or loyalty points.

enum

FIAT, LOYALTY