Swift API Sandbox Collections API Documentation
Validates the payment instruction.
POST {{baseUrl}}/payment/payment-instruction
This service validates various elements of the payment instruction whether it is a partial or complete payment instruction. And provides a comprehensive response with the result of the individual validations performed as well as the overall result of the validation.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
x-bic
|
string | (Required) BIC of SWIFT as SWIFT is performing the service, centrally. The x-bic value must be swhqbebb. | |
X-Request-ID
|
string | Unique end-to-end tracking identifier(ID) of the Payment Pre-validation API service request. Payment Pre-validation Users are not required to fill it in for the Payment Pre-validation API request. SWIFT provide the tracking ID which is an uuid as described in IETF RFC 4122 Universally Unique Identifier (UUID) URN Namespace.Pattern - ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$. | |
Content-Type
|
string | ||
Accept
|
string |
RESPONSES
status
Curl
curl -X POST 'https://sandbox.swift.com/swift-preval/v2/payment/payment-instruction' -H 'x-bic: swhqbebb' -H 'X-Request-ID: 0f70dd9b-11d4-1d02-049b-9caee3c80982' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"uetr":"dd3027ea-9460-480c-8ef4-0aed819a5ce8","instructed_amount":{"currency_code":"USD","amount":"10000.55"},"debtor_agent_country":"GB","creditor_agent":{"bicfi":"AAAAGB2L","clearing_system_member_identification":{"clearing_system_identification":{"code":"ACH"},"member_identification":"124567222"}},"creditor_agent_country":"US","creditor_agent_branch_identification":"NY8877888","creditor":{"name":"DEF Electronics","postal_address":{"structured":{"street_name":"1 Park Avenue","building_name":"Empire State Building","floor":"50th Floor","post_code":"10117","town_name":"New York","country":"US"}},"identification":{"organisation_identification":{"bic":"BBBBUS2L","other":[{"identification":"887766","scheme_name":{"code":"TIN"},"issuer":"US IRS"}]}}},"creditor_account":"7892368367","purpose":"GDDS","purpose_description":"Purchase of goods.","category_purpose":{"code":"SUPP"}}'
ENDPOINTS