Credit Transfers

Update credit transfer

Changed on Nov 3, 2026

Update a credit transfer.

The credit transfer execution date can only be changed if the credit transfer has not been scheduled for submission yet.

patch/payments/v2/credit-transfers/{id}

Request

Base URL
https://api.atlar.com
Auth
HTTP basic
TypeScript
https://skmtc.dev/atlar/apis/atlar-api-v2/docs/payments/v2/credit-transfers/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Atlar resource ID or External ID. Prefix External IDs with external:.

Headers

If-Matchstring

ETag (version) of resource to be updated.

Request body

Example request

[
  {
    "value": "2022-05-07"
  }
]

Response

The updated credit transfer.

idstring required

Unique resource identifier.

organizationIdstring required

Unique resource identifier for an Organization.

creatorUserIdstring

Unique resource identifier.

Payment scheme. Choose among: <ul>

<li><code>SCT</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/sepa-credit-transfer">SEPA Credit Transfer</a>)</li> <li><code>SCT_INST</code> (<a href="https://www.europeanpaymentscouncil.eu/what-we-do/sepa-instant-credit-transfer">SEPA Instant Credit Transfer</a>)</li> <li><code>CROSS_BORDER</code> (<a href="https://www.swift.com">Swift</a>)</li> <li><code>GB_CT_BACS</code> (UK account-to-account <a href="https://www.bacs.co.uk">BACS</a>) <li><code>GB_CT_CHAPS</code> (UK account-to-account <a href="https://www.bankofengland.co.uk/payment-and-settlement/chaps">CHAPS</a>)</li> <li><code>GB_CT_FPS</code> (UK account-to-account <a href="https://www.wearepay.uk/what-we-do/payment-systems/faster-payment-system/">Faster Payments</a>)</li> <li><code>SE_A2A</code> (Swedish account-to-account)</li> <li><code>SE_GIRO</code> (Swedish <a href="https://www.bankgirot.se">Bankgiro</a> and/or <a href="https://en.wikipedia.org/wiki/PlusGirot">PlusGiro</a>)</li> <li><code>DK_A2A</code> (Danish account-to-account)</li> <li><code>DK_CT_SAMEDAY</code> (Danish same-day credit transfer)</li> <li><code>DK_CT_INST</code> (Danish instant credit transfer)</li> <li><code>DK_CT_FIK71</code> (Danish FIK71 credit transfer)</li> <li><code>DK_CT_FIK73</code> (Danish FIK73 credit transfer)</li> <li><code>DK_CT_FIK75</code> (Danish FIK75 credit transfer)</li> <li><code>DK_CT_NEMKONTO</code> (Danish NemKonto credit transfer)</li> <li><code>DK_CT_T2</code> (Danish T2 credit transfer)</li> <li><code>CH_CT</code> (Swiss account-to-account)</li> <li><code>NO_CT</code> (Norwegian account-to-account)</li> <li><code>NO_CT_KID</code> (Norwegian KID payment)</li> <li><code>US_CT_ACH</code> (US ACH)</li> <li><code>US_CT_WIRE</code> (US Wire)</li> <li><code>IS_CT</code> (Icelandic account-to-account)</li> <li><code>AU_CT</code> (Australian account-to-account)</li> <li><code>AU_CT_BECS</code> (Australian BECS)</li> <li><code>AU_CT_BPAY</code> (Australian <a href="https://www.bpay.com.au/">BPAY</a>)</li> <li><code>HK_CT</code> (Hong Kong account-to-account)</li> <li><code>HK_CT_CHATS</code> (Hong Kong CHATS)</li> <li><code>HK_CT_FPS</code> (Hong Kong Faster Payment System)</li> <li><code>IL_CT</code> (Israel account-to-account)</li> <li><code>SG_CT</code> (Singapore account-to-account)</li> <li><code>SG_CT_FAST</code> (Singapore FAST)</li> <li><code>SG_CT_GIRO</code> (Singapore Giro)</li> <li><code>SG_CT_MEPS</code> (Singapore MEPS+)</li> <li><code>BG_CT</code> (Bulgarian account-to-account)</li> <li><code>CL_CT</code> (Chilean account-to-account)</li> <li><code>CO_CT</code> (Colombian account-to-account)</li> <li><code>CR_CT</code> (Costa Rican account-to-account)</li> <li><code>CZ_CT</code> (Czech account-to-account)</li> <li><code>MX_CT</code> (Mexican account-to-account)</li> <li><code>MX_CT_SPID</code> (Mexican account-to-account SPID USD)</li> <li><code>MX_CT_SPEI</code> (Mexican SPEI)</li> <li><code>MX_CT_TEF</code> (Mexican TEF)</li> <li><code>MY_CT_IBG</code> (Malaysian Interbank GIRO)</li> <li><code>MY_CT_JOMPAY</code> (Malaysian JomPAY)</li> <li><code>MY_CT_RENTAS</code> (Malaysian RENTAS)</li> <li><code>KR_CT</code> (South Korean account-to-account)</li> <li><code>TW_CT_ACH</code> (Taiwan ACH Credit Transfer)</li> <li><code>TW_CT_FISC</code> (Taiwan FISC Credit Transfer)</li> <li><code>TH_CT</code> (Thai account-to-account)</li> <li><code>TH_CT_BAHTNET</code> (Thailand BAHTNET)</li> <li><code>TH_CT_SMART</code> (Thailand SMART Credit)</li> <li><code>CA_CT_LYNX</code> (Canadian Lynx credit transfer)</li> <li><code>CA_CT_ACSS</code> (Canadian ACSS credit transfer)</li> <li><code>PE_CT</code> (Peruvian account-to-account)</li> <li><code>PL_CT</code> (Polish account-to-account)</li> <li><code>RO_CT</code> (Romanian account-to-account)</li> <li><code>TR_CT</code> (Turkish account-to-account)</li> <li><code>AE_CT</code> (UAE account-to-account)</li> <li><code>AE_CT_IPI</code> (UAE Instant Payment Instruction)</li> <li><code>DE_CT</code> (Legacy German account-to-account)</li> <li><code>FR_CT</code> (Legacy French account-to-account)</li> <li><code>IN_IMPS</code> (India Immediate Payment Service)</li> <li><code>IN_NEFT</code> (India National Electronic Funds Transfer)</li> <li><code>IN_RTGS</code> (India Real-Time Gross Settlement)</li> <li><code>BR_CT_PIX</code> (Brazilian <a href="https://www.bcb.gov.br/en/financialstability/pix_en">PIX</a>)</li> <li><code>BR_CT_TED</code> (Brazilian <a href="https://www.bcb.gov.br/meubc/faqs/p/o-que-e-transferencia-eletronica-disponivel-ted">TED</a>))</li> <li><code>BOOK_TRANSFER</code> (Book Transfer)</li> <li><code>CN_CT_BEPS</code> (Chinese Bulk Electronic Payment System)</li> <li><code>CN_CT_HVPS</code> (Chinese High Value Payment System)</li> <li><code>VN_CT</code> (Vietnamese account-to-account)</li> <li><code>PH_CT_PESONET</code> (Philippines PESONet)</li> <li><code>PH_CT_INSTAPAY</code> (Philippines InstaPay)</li> <li><code>PH_CT_PHILPASS</code> (Philippines PhilPaSS)</li> <li><code>PH_CT_PDDTS</code> (Philippines Domestic Dollar Transfer System)</li> <li><code>RS_CT</code> (Serbian account-to-account)</li> <li><code>JP_CT</code> (Japanese account-to-account)</li> <li><code>MU_CT</code> (Mauritian account-to-account)</li> <li><code>KE_CT_RTGS</code> (Kenya Real-Time Gross Settlement)</li> <li><code>GE_CT_RTGS</code> (Georgia Real-Time Gross Settlement)</li> <li><code>ZA_CT_EFT</code> (South African domestic EFT)</li> <li><code>BD_CT_BEFTN</code> (Bangladesh Electronic Funds Transfer Network)</li> <li><code>BD_CT_RTGS</code> (Bangladesh Real-Time Gross Settlement)</li> <li><code>MA_CT</code> (Moroccan account-to-account)</li> <li><code>SA_CT_SARIE</code> (Saudi Arabian SARIE)</li> <li><code>HU_CT_VIBER</code> (Hungarian VIBER)</li> <li><code>HU_CT_GIRO</code> (Hungarian GIRO)</li> </ul>

datestring date required

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21.

Status of a payment. Applicable to both credit transfer payments and direct debit payments.

referencestring required

This reference will be sent to the destination bank and recipient. (This type of reference is sometimes also referred to as remittance information.)

referenceType'STRUCTURED' | 'UNSTRUCTURED' | 'CREDITOR_REFERENCE'

The kind of reference carried by a payment's remittance information.

UNSTRUCTURED: free-text remittance information, carried on pain.001 as <RmtInf><Ustrd>.
CREDITOR_REFERENCE: a structured creditor reference such as ISO 11649 (RF), Finnish Viitenumero, Norwegian KID, or Swedish Bankgiro/Plusgiro OCR. Carried on pain.001 as <RmtInf><Strd><CdtrRefInf> with <Cd>SCOR</Cd>.
STRUCTURED: deprecated — use CREDITOR_REFERENCE instead. Retained so existing persisted records still parse.

categoryPurposestring

ISO 20022 Category Purpose Code (ExternalCategoryPurpose1Code).

chargeBearer'SHARED' | 'DEBTOR' | 'CREDITOR' | 'SERVICE_LEVEL'

Charge bearer specifies which party should bear the charges of the transaction.

connectionInstructionIdstring

The ID of the instruction that was sent to the bank in which this credit transfer was included when it was created.

paymentScheduleIdstring

Unique resource identifier.

etagstring required

ETag based on the resource version. This can be passed along in If-Match HTTP header when updating a resource to perform a conditional update.

externalIdstring

External ID is optional to use, but if used, the Atlar platform will persist it, index it, as well as require it to be unique across all resources. It is possible to retrieve a resource using the external ID using the prefix external:.

metadataMetadata nullable

Metadata is a string-string key-value container that can be used to store information known at the time of resource creation. This can be retrieved later on, for instance when a payment or expected transaction is reconciled with the booked transaction on the bank statement.

Metadata can have at most 20 entries. Keys may have a maximum length of 64 chars and values a maximum length of 512 chars.

By default, this field is optional. It is possible to make it required in the Atlar Dashboard by visiting the Metadata keys page. Requirement rules can be specified per API resource. Both the Dashboard and the API will then enforce these rules and give validation errors when the required fields are not set.

versioninteger required

Resource version. Starts at value 1 when the resource is created and increases by one for each successive update.

createdstring date-time required

Time at which the resource was created.

updatedstring date-time required

Time at which the resource was last updated.

Example response

{
  "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
  "creatorUserId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "amount": {
    "currency": "EUR",
    "stringValue": "15.02",
    "value": 1502
  },
  "scheme": "SCT",
  "schemeDetails": {
    "instrument": {
      "type": "CITI_WORLDLINK",
      "citiWorldlinkId": "123456789"
    }
  },
  "date": "2022-05-07",
  "status": "SENT",
  "statusReason": {
    "code": "DS02",
    "description": "EBICS VEU/EDS signature cancelled by user"
  },
  "source": {
    "id": "ac1963d7-fff9-4783-aa1d-92acb7b21a19",
    "type": "ACCOUNT",
    "organizationId": "0160f6ab-5741-49e1-af46-9138927e547e",
    "market": "DE",
    "currency": "EUR",
    "identifiers": [
      {
        "market": "DE",
        "type": "IBAN",
        "number": "DE89370400440532013000"
      }
    ],
    "routing": [
      {
        "type": "BIC",
        "number": "COBADEFFXXX"
      }
    ]
  },
  "sourceHolder": {
    "type": "ENTITY",
    "id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
    "legalName": "Example Company GmbH",
    "address": {
      "country": "DE",
      "city": "Munich",
      "postalCode": "123456"
    }
  },
  "destination": {
    "id": "31d593d7-fff9-4783-aa1d-92acb7b21a19",
    "organizationId": "605e26fc-4fce-495a-a92f-2c3592d7287e",
    "market": "GB",
    "type": "EXTERNAL_ACCOUNT",
    "identifiers": [
      {
        "type": "IBAN",
        "market": "GB",
        "number": "GB33BUKB20201555555555"
      }
    ],
    "routing": [
      {
        "type": "BIC",
        "number": "BUKBGB22XXX"
      }
    ]
  },
  "destinationHolder": {
    "type": "ENTITY",
    "id": "29a4555b-99b2-4de7-9062-47c8ebc03f56",
    "legalName": "Example Company GmbH",
    "address": {
      "country": "DE",
      "city": "Munich",
      "postalCode": "123456"
    }
  },
  "approvalSteps": [
    {
      "id": "735c7b8c-ef29-456a-8caf-113be117d131",
      "status": "APPROVED",
      "approver": {
        "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
        "username": "john.smith@example.com",
        "name": "John Smith",
        "roleId": "2a1e16eb-2f83-4597-99e2-cffbc4311df2"
      }
    }
  ],
  "attachedTransactions": [
    {
      "type": "TRANSACTION",
      "id": "27abf7cb-3867-4119-bfa7-ee3fb667ecf3"
    }
  ],
  "referenceType": "CREDITOR_REFERENCE",
  "categoryPurpose": "SALA",
  "chargeBearer": "SHARED",
  "regulatoryReporting": [
    {
      "market": "DE",
      "indicator": "CREDITOR"
    }
  ],
  "taxDetails": {
    "type": "PL_MPP",
    "amount": {
      "currency": "EUR",
      "stringValue": "15.02",
      "value": 1502
    }
  },
  "fxInstruction": {
    "rate": {
      "unitCurrency": "EUR"
    }
  },
  "connectionInstructionId": "c1d6502c-07c7-4c77-bee5-963f9464c7d8",
  "batch": {
    "id": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
    "treatment": "INDIVIDUAL_PAYMENTS"
  },
  "paymentScheduleId": "2ed9a3ee-60aa-4f9f-a858-2eed4eefbbc8",
  "etag": "version:3",
  "externalId": "walVNuin6X5Mvte4xhg1ibTAVSACfN4Q9hl",
  "metadata": {
    "my_metadata_key": "2a9a79b9-601c-449b-aa05-432f41dbbc4a"
  },
  "version": 1,
  "created": "2022-05-04T18:31:12.889104898Z",
  "updated": "2022-05-04T18:47:32.213842599Z"
}

Changes

Nov 3, 2026b49df1e4b3e9 Revision changes
- breaking
  the response property / became optional for the status
- breaking
  the response property / became optional for the status
- breaking
  added to the response property oneOf list for the response status
- warning
  added the new BD_BRN enum value to the /////// response property for the response status
- warning
  added the new BD_BRN enum value to the /////// response property for the response status
- warning
  added the new BD_BRN enum value to the /// response property for the response status
- warning
  added the new BD_CT_BEFTN enum value to the response property for the response status
- warning
  added the new BD_CT_RTGS enum value to the response property for the response status
- warning
  added the new CL_CT enum value to the response property for the response status
- warning
  added the new CN_CT_BEPS enum value to the response property for the response status
- warning
  added the new CN_CT_HVPS enum value to the response property for the response status
- warning
  added the new CO_CT enum value to the response property for the response status
- warning
  added the new CR_CT enum value to the response property for the response status
- warning
  added the new CZ_NBC enum value to the /////// response property for the response status
- warning
  added the new CZ_NBC enum value to the /////// response property for the response status
- warning
  added the new CZ_NBC enum value to the /// response property for the response status
- warning
  added the new DK_CT_T2 enum value to the response property for the response status
- warning
  added the new GE_CT_RTGS enum value to the response property for the response status
- warning
  added the new HK_CT_CHATS enum value to the response property for the response status
- warning
  added the new HK_CT_FPS enum value to the response property for the response status
- warning
  added the new HU_CT_GIRO enum value to the response property for the response status
- warning
  added the new HU_CT_VIBER enum value to the response property for the response status
- warning
  added the new INLINE enum value to the / response property for the response status
- warning
  added the new INLINE enum value to the / response property for the response status
- warning
  added the new KE_CT_RTGS enum value to the response property for the response status
- warning
  added the new MA_CT enum value to the response property for the response status
- warning
  added the new MU_CT enum value to the response property for the response status
- warning
  added the new MX_CT_SPEI enum value to the response property for the response status
- warning
  added the new MX_CT_TEF enum value to the response property for the response status
- warning
  added the new MY_CT_JOMPAY enum value to the response property for the response status
- warning
  added the new MY_JOMPAY_BILLER_CODE enum value to the /////// response property for the response status
- warning
  added the new MY_JOMPAY_BILLER_CODE enum value to the //////// response property for the response status
- warning
  added the new MY_JOMPAY_BILLER_CODE enum value to the /////// response property for the response status
- warning
  added the new MY_JOMPAY_BILLER_CODE enum value to the //////// response property for the response status
- warning
  added the new MY_JOMPAY_BILLER_CODE enum value to the /// response property for the response status
- warning
  added the new MY_JOMPAY_BILLER_CODE enum value to the //// response property for the response status
- warning
  added the new PE_CT enum value to the response property for the response status
- warning
  added the new PH_BRSTN enum value to the /////// response property for the response status
- warning
  added the new PH_BRSTN enum value to the /////// response property for the response status
- warning
  added the new PH_BRSTN enum value to the /// response property for the response status
- warning
  added the new SA_CT_SARIE enum value to the response property for the response status
- warning
  added the new SG_CT_GIRO enum value to the response property for the response status
- warning
  added the new SG_CT_MEPS enum value to the response property for the response status
- warning
  added the new TH_CT_BAHTNET enum value to the response property for the response status
- warning
  added the new TH_CT_SMART enum value to the response property for the response status
- warning
  added the new TW_CT_ACH enum value to the response property for the response status
- warning
  added the new TW_CT_FISC enum value to the response property for the response status
- warning
  added the new WALLET_AIRWALLEX_NUMBER enum value to the /////// response property for the response status
- warning
  added the new WALLET_AIRWALLEX_NUMBER enum value to the //////// response property for the response status
- warning
  added the new WALLET_AIRWALLEX_NUMBER enum value to the /////// response property for the response status
- warning
  added the new WALLET_AIRWALLEX_NUMBER enum value to the //////// response property for the response status
- warning
  added the new WALLET_AIRWALLEX_NUMBER enum value to the /// response property for the response status
- warning
  added the new WALLET_AIRWALLEX_NUMBER enum value to the //// response property for the response status
- warning
  added the new WALLET_UNIT enum value to the /////// response property for the response status
- warning
  added the new WALLET_UNIT enum value to the //////// response property for the response status
- warning
  added the new WALLET_UNIT enum value to the /////// response property for the response status
- warning
  added the new WALLET_UNIT enum value to the //////// response property for the response status
- warning
  added the new WALLET_UNIT enum value to the /// response property for the response status
- warning
  added the new WALLET_UNIT enum value to the //// response property for the response status
- warning
  added the new ZA_CT_EFT enum value to the response property for the response status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property / to the response with the status
- info
  added INLINE discriminator mapping keys to the response property for the response status
- info
  removed the CN_CT enum value from the response property for the response status

Operation history

Update credit transfer

Request

Path parameters

Headers

Request body

Example request

Response 202Accepted

Example response

Changes

Response