Logo
Swift API Sandbox Collections API Documentation

Clearing System Identification Request Raw

PUT {{baseUrl}}/payment-initiation-instructions/:uetr

Create a payment initiation instruction. The identifier of the instruction is uetr. The request accept an instruction which will be validated and created. On successful creation, the instruction can be retrieved using the uetr. The method is use to create a payment instruction as the consumer will supply the resource identifier (uetr) and the method is idempotent. This operation only supports creation of resource. The operation cannot be used to replace the resource once the resource is created.

 

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. 
Curl
curl -X PUT 'https://sandbox.swift.com/swift-payment-initiation/v1/payment-initiation-instructions/: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' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"end_to_end_identification":"string","creation_date_time":"3512-01-31T23:05:17.44562052282374402794732884182","payment_method":"TRF","instruction_priority":"HIGH","service_level":["stri"],"local_instrument":{"code":"stri"},"category_purpose":"stri","requested_execution_date":"2022-05-30T23:58:32Z","ultimate_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":"VP"}},"identification":{"organisation_identification":{"bic":"NXNWSJVR","lei":"T10YOE8J3GVSD9LK1297","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"SX"},"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":"HX"}},"identification":{"organisation_identification":{"bic":"QG6USCE5MEE","lei":"FT96NTL1NS8E442HJG09","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"RB"},"debtor_account":{"identification":{"iban":"MK79sKh5H5uTD1"},"type":{"code":"stri"},"currency":"TVW","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":"YR"}},"identification":{"organisation_identification":{"bic":"OMVEWNJK","lei":"7VVGBOFRBE1Q1JVKV351","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"JU"},"debtor_agent":{"bicfi":"MQH6HR5PP7Z","clearing_system_member_identification":{"clearing_system_identification":{"code":"strin"},"member_identification":"string"},"lei":"T3HCUMURU3OEIY3V9R81","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":"PN"}},"other":{"identification":"string","scheme_name":"string","issuer":"string"}},"charge_bearer":"DEBT","amount":{"instructed_amount":{"currency_code":"QAQ","amount":"000000001740077469."}},"exchange_rate_information":{"unit_currency":"BIZ","exchange_rate":"string","rate_type":"SPOT","contract_identification":"string"},"creditor_agent":{"bicfi":"RLMNIQ4S","clearing_system_member_identification":{"clearing_system_identification":{"code":"strin"},"member_identification":"string"},"lei":"64KBIZ25A02SWPLNXT65","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":"FY"}},"other":{"identification":"string","scheme_name":"string","issuer":"string"}},"creditor_agent_account":{"identification":{"iban":"XB5223zR3A1zDOUcmiij77tA5QJZPpyJ"},"type":{"code":"stri"},"currency":"USX","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":"HR"}},"identification":{"organisation_identification":{"bic":"HR2PTWPO","lei":"ZN5M4D5NKJVNPS2WZ359","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"CB"},"creditor_account":{"identification":{"iban":"EQ96Ashp0jeNbf6l3"},"type":{"code":"stri"},"currency":"OKR","name":"string","alternate_identification":{"identification":"string","scheme_name":"string","issuer":"string"}},"ultimate_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":"LQ"}},"identification":{"organisation_identification":{"bic":"ASV4YLFU","lei":"O2HIQXQA55XW8V5YUN18","other":[{"identification":"string","scheme_name":{"code":"stri"},"issuer":"string"}]}},"country_of_residence":"OS"},"purpose":"stri","regulatory_reporting":[{"debit_credit_reporting_indicator":"CRED","authority":{"name":"string","country":"MJ"},"details":[{"type":"string","date":"4469-01-30","country":"KD","code":"string","amount":{"currency_code":"GYP","amount":"0000000000000000000"},"information":["string"]}]}],"related_remittance_information":{"remittance_identification":"d63e0987-7c01-4304-86e3-600be05ecdd7","remittance_location_details":[{"method":"FAXI","electronic_address":"string"}]},"remittance_information":{"unstructured":"string"}}' 
  • FAQs
  • More
    Claim this page
    Report this page
ENDPOINTS