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

sourceAccountIdstring · uuidRequired

idempotencyKeystring · uuidRequired

amountnumberRequired

Amount in hundreds, ie. for £1.2 enter 120

Example: 129

externalReferencestring · uuidRequired

Reference of the payment

descriptionstring | nullableRequired

Description of the payment

Example: Sent from Algbra

railsstring · enum | nullableRequiredDefault: FASTER_PAYMENTSPossible values:

railsPolicystring · enum | nullableRequiredDefault: DETECTPossible values:

verificationMetadataall of | nullableRequired

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: 658

{
  "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": "FIXED",
  "verificationMetadata": {
    "verificationType": "BIOMETRIC_VERIFIED",
    "verificationReference": "text",
    "exemptionType": "LOW_VALUE",
    "exemptionReason": "text"
  }
}

{
  "paymentId": "123e4567-e89b-12d3-a456-426614174000",
  "processingState": "CREATED",
  "createdOn": "2025-05-09T09:25:30.489Z",
  "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-05-09T09:25:30.489Z"
  },
  "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.