Swift API Sandbox Collections API Documentation
Validates the payment purpose.
POST {{baseUrl}}/payment/payment-purpose
This request validates the instructed information regarding the purpose of the payment (purpose code, purpose description) based on the specific requirements available in the SWIFT repository, for the instructed payment context (creditor country, creditor account currency and local payment market infrastructure).
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-purpose' -H 'x-bic: swhqbebb' -H 'X-Request-ID: 0f70dd9b-11d4-1d02-049b-9caee3c80982' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"purpose_code":"COM","country_code":"AE"}'
ENDPOINTS