Initiate Direct Debit Transactions | Citi Docs Demo

curl -X POST "https://tts.sit.apib2b.citi.com/citiconnect/sit5/receivablesservices/v1/directdebits?client_id=4683fd9f-03fe-4268-b5da-93bf8203fd91" \
     -H "Idempotency-Id: a44cbb60123414bba3bb" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "debtor": {
    "name": "Shan",
    "account_type": "AIIN",
    "account": "3459284",
    "proxy_type": "DNAM",
    "proxy_id": "215264475588455744",
    "bank_branch_code": "3245245",
    "bank_routing_code": "CHN0IN0D00A"
  },
  "creditor": {
    "account_type": "AIIN",
    "name": "John",
    "account": "473628234",
    "proxy_type": "DNAM",
    "proxy_id": "215264475588455744",
    "bank_branch_code": "3245245",
    "bank_routing_code": "MUM0IN0C00G"
  },
  "method": {
    "country": "AU",
    "instructed_currency": "AUD",
    "payment_method": "IP",
    "payment_type": "DD"
  },
  "transaction": {
    "end_to_end_id": "AUDIDD343D",
    "value_date": "2022-07-21T17:32:16.258Z",
    "instructed_amount": "3423.54",
    "uetr": "0c4fb98b-d77a-4468-96bb-0c88b3b8f75a",
    "purpose": "MORT",
    "bo_service_code": "x2p1.01",
    "additional_info": "AU IDD request",
    "instruction_priority": "UNAT",
    "unique_superannuation_code": "12345",
    "unique_superannuation_identification": "test one"
  },
  "initiating_party": {
    "name": "Sean",
    "account": "3213423",
    "bank_routing_code": "VAS0IN0S00H",
    "other_identification_type": "AUBN",
    "other_identification": "AU1SACITIAU2XXXX"
  },
  "mandate_details": {
    "mandate_id": "3461fa9f03fe4268b5da93bf8203ad70"
  },
  "ultimate": {
    "ultimate_creditor_name": "creditor Australia",
    "ultimate_debtor_name": "debtor Australia"
  }
}'

{
  "debtor": {
    "name": "Shan",
    "account_type": "AIIN",
    "account": "3459284",
    "proxy_type": "DNAM",
    "proxy_id": "215264475588455744",
    "bank_branch_code": "3245245",
    "bank_routing_code": "CHN0IN0D00A"
  },
  "creditor": {
    "account_type": "AIIN",
    "name": "John",
    "account": "473628234",
    "proxy_type": "DNAM",
    "proxy_id": "215264475588455744",
    "bank_branch_code": "3245245",
    "bank_routing_code": "MUM0IN0C00G"
  },
  "initiating_party": {
    "name": "Sean",
    "account": "3213423",
    "bank_routing_code": "VAS0IN0S00H",
    "other_identification_type": "AUBN",
    "other_identification": "AU1SACITIAU2XXXX"
  },
  "method": {
    "country": "AU",
    "instructed_currency": "AUD",
    "payment_method": "IP",
    "payment_type": "DD"
  },
  "transaction": {
    "end_to_end_id": "AUDIDD343D",
    "value_date": "2022-07-21T17:32:16.258Z",
    "instructed_amount": "3423.54",
    "uetr": "e82540a1-bab9-41f3-b17a-f9b3ee27983f",
    "purpose": "MORT",
    "bo_service_code": "x2p1.01",
    "additional_info": "AU IDD request",
    "instruction_priority": "UNAT",
    "unique_superannuation_code": "12345",
    "unique_superannuation_identification": "test one"
  },
  "mandate_details": {
    "mandate_id": "3461fa9f03fe4268b5da93bf8203ad70"
  },
  "ultimate": {
    "ultimate_creditor_name": "creditor Australia",
    "ultimate_debtor_name": "debtor Australia"
  },
  "transaction_status": {
    "status": "PDNG",
    "status_date_time": "2022-07-21T17:32:11.258Z"
  }
}

This endpoint allows you to initiate a direct debit transaction.

Authentication

AuthorizationBearer

All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token.

Query parameters

client_idstringRequired

Unique reference which was shared during CitiConnect API on-boarding (ClientId which used during oauth token generation).

Request

Request body for direct debit transaction.

debtorobjectRequired

creditorobjectRequired

methodobjectRequired

transactionobjectRequired

initiating_partyobjectOptional

mandate_detailsobjectOptional

ultimateobjectOptional

Response

debtorobjectOptional

creditorobjectOptional

initiating_partyobjectOptional

methodobjectOptional

transactionobjectOptional

mandate_detailsobjectOptional

ultimateobjectOptional

transaction_statusobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

405

Method Not Allowed Error

409

Conflict Error

415

Unsupported Media Type Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Headers

Query parameters

Request

Response

Errors