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

Annotate an bank accountPATCH/v1/bank-account/{id}/annotations

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

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

const result = await client.annotateBankAccount({
  id: "bank-account/28958679-e8a8-47a8-967c-f979ae8509a2",
  annotations: {
    everything: "42",
    bike: "bar"
  }
});

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

requests.patch(
  "https://api-json.sandbox.paybase.io/v1/bank-account/bank-account/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/annotations",
  data = json.dumps({
    "annotations": {
      "everything": "42",
      "bike": "bar"
    }
  }),
  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
17
$client = new \GuzzleHttp\Client();
$client->request(
  "patch",
  "https://api-json.sandbox.paybase.io/v1/bank-account/bank-account/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/annotations",
  [
    "body" => "{
      \"annotations\": {
        \"everything\": \"42\",
        \"bike\": \"bar\"
      }
    }",
    "headers" => [
      "Content-Type" => "application/json",
      "X-Token" => "<X-Token goes here>",
    ]
  ]
);

1
2
3
4
5
6
7
8
9
10
curl -X PATCH \
"https://api-json.sandbox.paybase.io/v1/bank-account/bank-account/28958679-e8a8-47a8-967c-f979ae8509a2Params: id/annotations"  -H "Content-Type: application/json" \
  -H "X-Token: <X-Token goes here>" \
  -d '{
    "annotations": {
      "everything": "42",
      "bike": "bar"
    }
  }'

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

annotationsrequired
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.

Response

FieldDescription
id
string

The unique identifier of the bank account object.

Format

bank_account/_uuid_

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

createdAt
date

The timestamp in UTC at which the bank account was created.

updatedAt
date

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

stateId
enum

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

enum

PENDING, ENABLED, DISABLED, CLOSED

Once CLOSED, a bank account cannot be ENABLED again.

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.

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.

accountNumber
string

The eight-digit UK bank account number used for processing UK Faster Payments.

sortCode
string

The six-digit sort code associated with a UK bank account.

Format

Six digits without dashes e.g. 123456

iban
string

The IBAN of the bank account.

Format

IBAN in ISO 13616 format.

Examples:

  • Belgium: BE71 0961 2345 6769

  • France: FR76 3000 6000 0112 3456 7890 189

  • Germany: DE91 1000 0000 0123 4567 89

  • Greece: GR96 0810 0010 0000 0123 4567 890

  • Romania: RO09 BCYP 0000 0012 3456 7890

  • Spain: ES79 2100 0813 6101 2345 6789

  • Switzerland: CH56 0483 5012 3456 7800 9

  • United Kingdom: GB98 MIDL 0700 9312 3456 78

bic
string

The SWIFT BIC of the bank account.

Format

8 or 11 characters e.g. DABAIE2D

currencyISO
string

The currency in which the bank account will be paid.

Format

Three-letter ISO 4217 code. e.g. GBP

This is the currency that will be PAID into the bank account, and NOT the currency in which the account is held. Any required FX will be performed by the recipient bank.

countryISO
string

The country where the bank account is held.

Format

Two-letter ISO 3166-1 alpha-2 code. e.g. GB

ownerId
string

The id of the Customer that owns the bank account.

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