ClearBank.Payments.CrossBorder (ClearBank v1.0.0)

Copy Markdown View Source

GBP Cross-Border Payments — sending GBP internationally via SWIFT/correspondent banking.

⚠️ Deprecation notice: This endpoint (/payments/cross-border-sterling/v3/payments) is deprecated as of 13 May 2026 and reaches end-of-life on 13 November 2026. Migrate to the Multi-currency payments API before that date.

Examples

{:ok, result} = ClearBank.Payments.CrossBorder.send(client, %{
  account_id: "acct-uuid",
  amount: "1000.00",
  currency: "GBP",
  creditor_name: "ACME Corp",
  creditor_iban: "DE89370400440532013000",
  creditor_bic: "COBADEFFXXX",
  remittance_information: "Invoice 1234"
})

Summary

Functions

Sends a GBP cross-border payment.

Functions

send(client, params)

This function is deprecated. Use ClearBank.MultiCurrency.Payments instead. EOL: 13 Nov 2026..

Sends a GBP cross-border payment.

Deprecated. Use ClearBank.MultiCurrency.Payments.send/2 instead.