Outbound Payments

Create external payment

POSTapi-url/v1/partner/payments/customers/{customerId}/payments/external

Path parameters

customerId*string

Header parameters

Body

application/json

sourceAccountId*string (uuid)

destinationCounterparty*object

idempotencyKey*string (uuid)

amount*number

Amount in hundreds, ie. for £1.2 enter 120

Example: 129

externalReference*string (uuid)

Reference of the payment

description*nullable string

Description of the payment

Example: "Sent from Algbra"

rails*nullable enum

FASTER_PAYMENTSCHAPSBACSINTERNAL

railsPolicy*nullable enum

FIXEDDETECT

verificationMetadata*nullable all of

Response

200400403412

Returns payment id to be used in the next step

Body

application/json

paymentId*string (uuid)

processingState*enum

CREATEDPROCESSINGSUCCESSFAILURE

createdOn*string (date-time)

transaction*nullable all of

initiationRequest*one of

objectobject

Request

JavaScriptCurlPythonHTTP

const response = await fetch('api-url/v1/partner/payments/customers/{customerId}/payments/external', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sourceAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "destinationCounterparty": {
        "type": "PERSONAL",
        "details": {
          "firstName": "John",
          "lastName": "Doe"
        },
        "accountCurrency": "GBP",
        "accountReferenceType": "UK_ACCOUNT",
        "accountReference": {
          "type": "UK_ACCOUNT",
          "sortCode": "010102",
          "accountNumber": "12345678"
        }
      },
      "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
      "amount": 129,
      "externalReference": "123e4567-e89b-12d3-a456-426614174000",
      "description": "Sent from Algbra",
      "rails": "FASTER_PAYMENTS",
      "railsPolicy": "DETECT",
      "verificationMetadata": {
        "verificationType": "BIOMETRIC_VERIFIED",
        "verificationReference": "text",
        "exemptionType": "LOW_VALUE",
        "exemptionReason": "text"
      }
    }),
});
const data = await response.json();

Response

200400403412

{
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "processingState": "CREATED",
  "createdOn": "2025-02-05T06:46:56.833Z",
  "transaction": {
    "transactionId": "text",
    "uniqueToken": "123e4567-e89b-12d3-a456-426614174000",
    "origin": "TRANSFER",
    "state": "PENDING",
    "category": "GENERAL",
    "impactType": "NEUTRAL",
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 129,
    "currencyCode": "AFN",
    "description": "text",
    "exchangeRate": "text",
    "exchangeCurrencyCode": "AFN",
    "sourceCounterparty": {
      "type": "PERSONAL",
      "details": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "accountCurrency": "GBP",
      "accountReferenceType": "UK_ACCOUNT",
      "accountReference": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    },
    "destinationCounterparty": {
      "type": "PERSONAL",
      "details": {
        "firstName": "John",
        "lastName": "Doe"
      },
      "accountCurrency": "GBP",
      "accountReferenceType": "UK_ACCOUNT",
      "accountReference": {
        "type": "UK_ACCOUNT",
        "sortCode": "010102",
        "accountNumber": "12345678"
      }
    },
    "transactionDate": "2025-02-05T06:46:56.833Z"
  },
  "initiationRequest": {
    "sourceAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "destinationAccountId": "123e4567-e89b-12d3-a456-426614174000",
    "idempotencyKey": "123e4567-e89b-12d3-a456-426614174000",
    "amount": 129,
    "externalReference": "123e4567-e89b-12d3-a456-426614174000",
    "description": "Sent from Algbra"
  }
}

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.