Outbound Payments

Create external payment

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

sourceAccountIdstring · uuidRequired

Source account id from which payment is sent

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

destinationCounterpartyall ofRequired

Counterparty details of the payment destination

idempotencyKeystring · uuidRequired

Unique key to ensure idempotency of payment requests

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

amountnumberRequired

Amount in minor units (e.g. for £1.29 enter 129)

Example: 129

externalReferencestring · uuidRequired

Reference identifier provided by partner.

Example: ae588135-0391-42a8-a4e4-e8e7645fa707

descriptionstring | nullableRequired

Description of the payment

Example: Sent from Algbra

railsstring · enum | nullableRequired

The payment rail to use (e.g. Faster Payments)

Default: FASTER_PAYMENTSExample: FASTER_PAYMENTSPossible values:

railsPolicystring · enum | nullableRequired

Policy for determining which rail to use

Default: DETECTPossible values:

verificationMetadataall ofRequired

Metadata required to verify the payment request

purposestring · enum | nullableRequired

Purpose of the payment

Example: PAY_INVOICEPossible values:

Responses

200

Returns payment id to be used in the next step

application/json

400

Input validation error

application/json

403

Forbidden

application/json

412

Precondition failed

application/json

post

HTTPcURLJavaScriptPython

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

{
  "sourceAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1",
  "destinationCounterparty": {
    "type": "PERSONAL",
    "details": {
      "firstName": "John",
      "lastName": "Doe"
    },
    "accountCurrency": "GBP",
    "accountReferenceType": "UK_ACCOUNT",
    "accountReference": {
      "type": "UK_ACCOUNT",
      "accountNumber": "12345678",
      "sortCode": "010102"
    }
  },
  "idempotencyKey": "1483d25d-3f00-4d39-90ce-2379a130becd",
  "amount": 129,
  "externalReference": "ae588135-0391-42a8-a4e4-e8e7645fa707",
  "description": "Sent from Algbra",
  "rails": "FASTER_PAYMENTS",
  "railsPolicy": "DETECT",
  "verificationMetadata": {
    "verificationType": "SMS_OTP_VERIFIED",
    "verificationReference": "text",
    "exemptionType": "INTERNAL_COUNTERPARTY",
    "exemptionReason": "text"
  },
  "purpose": "PAY_INVOICE"
}

{
  "paymentId": "1489dd60-aa06-48a6-a267-e7d4a9a84200",
  "processingState": "SUCCESS",
  "createdOn": "2025-09-12T15:17:08.888Z",
  "transaction": {
    "transactionId": "68c2a19131a3b726fe47fdda",
    "uniqueToken": "1489dd60-aa06-48a6-a267-e7d4a9a84200",
    "origin": "TRANSFER",
    "state": "COMPLETED",
    "category": "TRANSFERS",
    "impactType": "CREDIT",
    "customerId": "a2b9649e-df7f-4349-adff-1c57283fef10",
    "amount": 129,
    "currencyCode": "GBP",
    "description": "Sent from Algbra",
    "exchangeRate": "1.0",
    "exchangeCurrencyCode": "GBP",
    "sourceCounterparty": {
      "type": "PERSONAL",
      "details": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "accountCurrency": "GBP",
      "accountReferenceType": "UK_ACCOUNT",
      "accountReference": {
        "type": "UK_ACCOUNT",
        "accountNumber": "12345678",
        "sortCode": "010102"
      }
    },
    "destinationCounterparty": {
      "type": "PERSONAL",
      "details": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "accountCurrency": "GBP",
      "accountReferenceType": "UK_ACCOUNT",
      "accountReference": {
        "type": "UK_ACCOUNT",
        "accountNumber": "12345678",
        "sortCode": "010102"
      }
    },
    "transactionDate": "2025-01-01T10:32:01.162Z",
    "transferMetadata": {
      "rails": "FASTER_PAYMENTS",
      "transactionProgress": [
        {
          "event": "COMPLETED",
          "date": "2025-01-01T10:16:49.621Z"
        }
      ]
    }
  },
  "initiationRequest": {
    "sourceAccountId": "e0cab2dd-739f-43de-b131-3e423e935bf1",
    "destinationAccountId": "ae66fcb2-2852-4568-990d-accc78572e4d",
    "idempotencyKey": "1483d25d-3f00-4d39-90ce-2379a130becd",
    "amount": 129,
    "externalReference": "ae588135-0391-42a8-a4e4-e8e7645fa707",
    "description": "Sent from Algbra",
    "verificationMetadata": {
      "verificationType": "SMS_OTP_VERIFIED",
      "verificationReference": "text",
      "exemptionType": "INTERNAL_COUNTERPARTY",
      "exemptionReason": "text"
    },
    "purpose": "PAY_INVOICE"
  }
}

SEPA Rails

For partners who need to make payments to other countries within the European Union, the API supports the Single Euro Payments Area (SEPA) payment scheme. SEPA covers the whole of the EU as well as Andorra, Iceland, Norway, Switzerland, Liechtenstein, Monaco, San Marino, United Kingdom, Vatican City State, Mayotte, Saint-Pierre-et Miquelon, Guernsey, Jersey and Isle of Man. This means that customers can make payments to other SEPA countries using the same standard process as they would for domestic payments, simplifying the payment process and reducing transaction costs.