Logo
Swift API Sandbox Collections API Documentation

Verify the payment for Rulebook eligibility and obtain payment predictability.

POST {{baseUrl}}/payment/eligibility-check

This service validates whether the given payment information satisfies the Rulebook eligibility requirements for the payment. The validation happens on the amount and the currency and whether a valid route exists for the payment to be processed as per the applicable Rulebook.

In addition to validating payment information, this eligibility service also returns payment predictability information such as routing options, end to end interbank fees and payment’s time to creditor, in order for financial institutions to support the payment end originators and increase the predictability of the execution of payments.

This service supports SWIFT Go only.

Note - The data in the request and response examples are fictitious.

 

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/eligibility-check' -H 'x-bic: swhqbebb' -H 'X-Request-ID: 0f70dd9b-11d4-1d02-049b-9caee3c80982' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"requestor_agent":{"bicfi":"CCLABEBB"},"creditor_agent":{"bicfi":"BANKUS33","clearing_system_member_identification":{"clearing_system_identification":{"code":"ABA"},"member_identification":"123456789"}},"amount":{"value":"5000","currency":"EUR"},"route_sorting":{"sorting_criteria":"cut-off-time","sorting_order":"ASC"}}'

ENDPOINTS