Logo
Swift API Sandbox Collections API Documentation

Create Direct Debit Initiation Request Raw

PUT {{baseUrl}}/direct-debit-initiation-instruction/:uetr

Payment, initiated by the creditor, to debit a debtor's account in favour of the creditor. The Direct Debit Initiation Instruction is sent by the Creditor sending party to the Debtor receiving party, directly or through agents. It is used by a Creditor to request funds from the debtor account to a creditor.

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
X-Request-ID
string Specify an unique end to end tracking request ID. The element will be populated by the SWIFT API gateway
X-SWIFT-Signature
string (Required) The information is needed to support non-repudiation. The application level signature produced based on asymmetric cryptography (see [JWS](https://tools.ietf.org/html/rfc7515)). The input data elements used to compute the signature are: * abs_path (see [RFC 2616](https://tools.ietf.org/html/rfc2616#section-3.2.2)) * HTTP request body See [RFC 7519](https://tools.ietf.org/html/rfc7519) See [jwt.io](https://jwt.io)
X-UserContext
string Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.
X-ServiceProvider
string Provides requester entitlement information to service provider. A JWT containing a claim representing the entitlements of the API consumer as defined at the SWIFT Identity Provider. This header is provided by the SWIFT API Gateway and is not required to be provided by the API consumer.
X-BIC
string (Required) Specify the BIC of the provider of the service. The identification will be used by the API Gateway to forward the request to service provider.




RESPONSES

Curl
curl -X PUT 'https://sandbox.swift.com/swift-payment-initiation/v1/direct-debit-initiation-instruction/:uetr' -H 'X-Request-ID: <string>' -H 'X-SWIFT-Signature: x-swift-signature' -H 'X-UserContext: <string>' -H 'X-ServiceProvider: <string>' -H 'X-BIC: DEUTDEFF' -d '{"end_to_end_identification":"string","creation_date_time":"8000-02-29T23:51:23","sequence_type":"FRST","requested_collection_date":"1600-02-29","initiating_party":{"name":"string","postal_address":{"structured":{"department":"string","sub_department":"string","street_name":"string","building_number":"string","building_name":"string","floor":"string","post_box":"string","room":"string","post_code":"string","town_name":"string","town_location_name":"string","district_name":"string","country_sub_division":"string","country":"GB"}},"identification":{"organisation_identification":{"bic":"1FAHLFK29KW","lei":"DC2APY3BO5F030N45H72","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"GB"},"debtor_account":{"identification":{"iban":"CO952px6g9zH1bqZasdvjaF6kXpdw"},"type":{"code":"stri"},"currency":"GBP","name":"string","alternate_identification":{"identification":"string","scheme_name":"string","issuer":"string"}},"debtor":{"name":"string","postal_address":{"structured":{"department":"string","sub_department":"string","street_name":"string","building_number":"string","building_name":"string","floor":"string","post_box":"string","room":"string","post_code":"string","town_name":"string","town_location_name":"string","district_name":"string","country_sub_division":"string","country":"GB"}},"identification":{"organisation_identification":{"bic":"70X6ZHIMR6U","lei":"506SK90XIE7FL1V8JL85","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"GB"},"debtor_agent":{"bicfi":"SCYTYWA0TU5","clearing_system_member_identification":{"clearing_system_identification":{"code":"strin"},"member_identification":"string"},"lei":"3N38TE11008U2O9EAB46","name":"string","postal_address":{"structured":{"department":"string","sub_department":"string","street_name":"string","building_number":"string","building_name":"string","floor":"string","post_box":"string","room":"string","post_code":"string","town_name":"string","town_location_name":"string","district_name":"string","country_sub_division":"string","country":"GB"}},"other":{"identification":"string","scheme_name":"string","issuer":"string"}},"instructed_amount":{"currency_code":"GBP","amount":"0000000000000000000"},"creditor_agent":{"bicfi":"CL8AFBZ7","clearing_system_member_identification":{"clearing_system_identification":{"code":"strin"},"member_identification":"string"},"lei":"MB9N5QAVPIS7E2E7OF82","name":"string","postal_address":{"structured":{"department":"string","sub_department":"string","street_name":"string","building_number":"string","building_name":"string","floor":"string","post_box":"string","room":"string","post_code":"string","town_name":"string","town_location_name":"string","district_name":"string","country_sub_division":"string","country":"GB"}},"other":{"identification":"string","scheme_name":"string","issuer":"string"}},"creditor_agent_account":{"identification":{"iban":"XV88bHlKP6XzB7T67s2uE3KbigfjB"},"type":{"code":"stri"},"currency":"GBP","name":"string","alternate_identification":{"identification":"string","scheme_name":"string","issuer":"string"}},"creditor":{"name":"string","postal_address":{"structured":{"department":"string","sub_department":"string","street_name":"string","building_number":"string","building_name":"string","floor":"string","post_box":"string","room":"string","post_code":"string","town_name":"string","town_location_name":"string","district_name":"string","country_sub_division":"string","country":"GB"}},"identification":{"organisation_identification":{"bic":"DZ6NWGIQR4M","lei":"F8PX5IO3A2MTQVX3YS45","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"GB"},"creditor_account":{"identification":{"iban":"CS59620xB09E33s2QefRPMMD"},"type":{"code":"stri"},"currency":"GBP","name":"string","alternate_identification":{"identification":"string","scheme_name":"string","issuer":"string"}},"purpose":"stri","mandate_information":{"mandate_identification":"string","date_of_signature":"2022-09-12"}}'

ENDPOINTS