Externally Issued Cards

When transactions are generated using this method, they incorporate a standardized transaction description that is crafted based on the inputs specified during the funding request. This ensures that all transactions are uniformly documented, providing clear and consistent information regarding the nature and purpose of the transaction. The standardization enhances transparency and simplifies record-keeping, making it easier for users to track and reconcile transactions associated with card funding activities.

Initiate card funding

post

Path parameters

customerIdstringRequired

Header parameters

authorizationstringOptional

Authorization header containing your API Token

x-alg-noncestringOptional

Nonce used to generate the payload signature

x-alg-signaturestringOptional

Payload signature

datestringOptional

Date of the request un UTC/GMT

Body

application/json

amountnumberRequired

Amount of the funding in minor units (e.g., for £1.29 enter 129).

Example: 129

idempotencyKeystring · uuidRequired

Idempotency key to prevent duplicate funding operations.

Example: 1483d25d-3f00-4d39-90ce-2379a130becd

externalReferencestring · uuidRequired

External reference identifier provided by partner.

Example: 550e8400-e29b-41d4-a716-446655440000

phasestring · enumRequired

Phase of the card transaction.

Example: AUTHORIZATIONPossible values:

typestring · enumOptional

Type of the card transaction. Optional but recommended for accurate reference generation.

Example: CARD_PAYMENTPossible values:

transactionTokenstring · uuidRequired

Unique reference for the card transaction, to logically group multiple events.

Example: 1483d25d-3f00-4d39-90ce-2379a130becd

eventTokenstring · uuidRequired

Unique reference for the card event.

Example: 1483d25d-3f00-4d39-90ce-2379a130becd

sourceAccountIdstring · uuidRequired

ID of the source account.

Example: e0cab2dd-739f-43de-b131-3e423e935bf1

destinationAccountIdstring · uuidRequired

ID of the destination account.

Example: e0cab2dd-739f-43de-b131-3e423e935bf1

cardTokenstring · uuidOptional

Unique reference for the card.

Example: 1483d25d-3f00-4d39-90ce-2379a130becd

customerIdstring · uuidRequired

ID of the customer.

Example: 1483d25d-3f00-4d39-90ce-2379a130becd

lastDigitsstringRequired

Last 4 digits of the card.

Example: 1234Pattern: ^[0-9]{4}$

schemeall ofOptional

Card transaction scheme information (network, bin prefix, etc.).

Example: {"network":"MasterCard","binPrefix":"5432","referenceId":"ref123"}

cardAcceptorall ofOptional

Card acceptor information (merchant details).

Example: {"mcc":"5411","name":"Supermarket","city":"London","country":"GB"}

posall ofOptional

Point of sale information.

Example: {"cardPresent":true,"pinPresent":false,"terminalId":"TERM001"}

Responses

201

Returns card funding initiation response

application/json

400

Input validation error

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable entity

application/json

post

/v1/partner/cards/external/funding/customers/{customerId}

HTTPcURLJavaScriptPython

POST /v1/partner/cards/external/funding/customers/{customerId} HTTP/1.1
Host: api-url
Content-Type: application/json
Accept: */*
Content-Length: 754

{
  "amount": 129,
  "idempotencyKey": "1483d25d-3f00-4d39-90ce-2379a130becd",
  "externalReference": "550e8400-e29b-41d4-a716-446655440000",
  "phase": "AUTHORIZATION",
  "type": "CARD_PAYMENT",
  "transactionToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
  "eventToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
  "sourceAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1",
  "destinationAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1",
  "cardToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
  "customerId": "1483d25d-3f00-4d39-90ce-2379a130becd",
  "lastDigits": "1234",
  "scheme": {
    "network": "MasterCard",
    "binPrefix": "5432",
    "referenceId": "ref123"
  },
  "cardAcceptor": {
    "mcc": "5411",
    "name": "Supermarket",
    "city": "London",
    "country": "GB"
  },
  "pos": {
    "cardPresent": true,
    "pinPresent": false,
    "terminalId": "TERM001"
  }
}

{
  "paymentId": "1489dd60-aa06-48a6-a267-e7d4a9a84200",
  "processingState": "SUCCESS",
  "createdOn": "2025-10-30T16:40:08.227Z",
  "transaction": {
    "transactionId": "68c2a19131a3b726fe47fdda",
    "uniqueToken": "1489dd60-aa06-48a6-a267-e7d4a9a84200",
    "origin": "CARD",
    "state": "COMPLETED",
    "category": [
      "GENERAL"
    ],
    "impactType": "DEBIT",
    "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
    "amount": 129,
    "currencyCode": "GBP",
    "description": "CL4252-3423",
    "exchangeRate": "1.0",
    "exchangeCurrencyCode": "GBP",
    "sourceCounterparty": {
      "type": "PERSONAL",
      "details": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "accountCurrency": "GBP",
      "accountReferenceType": "UK_ACCOUNT",
      "accountReference": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    },
    "destinationCounterparty": {
      "id": "A0000EXTM"
    },
    "transactionDate": "2025-01-01T10:32:01.162Z",
    "transferMetadata": {
      "rails": "FASTER_PAYMENTS",
      "transactionProgress": [
        {
          "event": "COMPLETED",
          "date": "2025-01-01T10:16:49.621Z"
        }
      ],
      "fundingSourceProvider": {
        "id": "f49281c0-0840-55bd-95b3-3b46d1d0e9f1",
        "name": "John Doe",
        "type": "PISP",
        "logo": "https://app-static.algbra.com/banklogo/mock-payments-gb-redirect.png"
      }
    }
  },
  "initiationRequest": {
    "amount": 129,
    "idempotencyKey": "1483d25d-3f00-4d39-90ce-2379a130becd",
    "externalReference": "550e8400-e29b-41d4-a716-446655440000",
    "phase": "AUTHORIZATION",
    "type": "CARD_PAYMENT",
    "transactionToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
    "eventToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
    "sourceAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1",
    "destinationAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1",
    "cardToken": "1483d25d-3f00-4d39-90ce-2379a130becd",
    "customerId": "1483d25d-3f00-4d39-90ce-2379a130becd",
    "lastDigits": "1234",
    "scheme": {
      "network": "MasterCard",
      "binPrefix": "5432",
      "referenceId": "ref123"
    },
    "cardAcceptor": {
      "mcc": "5411",
      "name": "Supermarket",
      "city": "London",
      "country": "GB"
    },
    "pos": {
      "cardPresent": true,
      "pinPresent": false,
      "terminalId": "TERM001"
    }
  }
}