ClearBank.MultiCurrency.SepaCreditTransfer (ClearBank v1.0.0)

Copy Markdown View Source

SEPA Credit Transfer UK (SCT UK) — send and return euro payments via the SEPA Credit Transfer scheme from within the UK.

Post-Brexit, this enables ClearBank UK clients to participate in euro SEPA payments using the SCT UK framework.

Key facts

  • Currency: EUR only
  • Scheme: SEPA Credit Transfer
  • Endpoint: ISO 20022 pacs.008 (customer) and pacs.004 (return)

Examples

{:ok, result} = ClearBank.MultiCurrency.SepaCreditTransfer.send(client, %{
  debtor_account_id: "eur-acct-uuid",
  amount: "2500.00",
  creditor_name: "Müller GmbH",
  creditor_iban: "DE89370400440532013000",
  creditor_bic: "COBADEFFXXX",
  remittance_information: "Invoice DE-2024-001"
})

Summary

Functions

Returns a received SEPA Credit Transfer UK payment.

Sends a SEPA Credit Transfer UK payment.

Functions

return_payment(client, params)

@spec return_payment(ClearBank.Client.t(), map()) :: ClearBank.HTTP.result()

Returns a received SEPA Credit Transfer UK payment.

Required params

  • :original_instruction_id - instruction ID of the original payment
  • :debtor_account_id - account to return from
  • :return_reason_code - ISO 20022 reason code (e.g. "AC03", "CUST")
  • :amount - return amount

send(client, params)

Sends a SEPA Credit Transfer UK payment.

Required params

  • :debtor_account_id - source EUR account UUID
  • :amount - decimal string (EUR)
  • :creditor_name - beneficiary name
  • :creditor_iban - beneficiary IBAN
  • :creditor_bic - beneficiary BIC
  • :remittance_information - payment reference

Optional params

  • :end_to_end_id - end-to-end reference
  • :instruction_id - unique instruction ID