Funds Availability

Check

This endpoint is used to check availability of funds for a specific account.

CURL

curl -i \ -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImFtb3VudCI6MTAwLCJjdXJyZW5jeV9jb2RlIjoiR0JQIiwiYWNjb3VudCI6Ijg0NTcyNDg2In0sImV4cCI6MTcxMzk0MDM2OH0.UkjGZ6vqs1YO7P8nsUdwOCk5a_Uc0ZP9A3FpEV6BAgNfHRSa0Clm5HGJ7ZC19pEkFBoSQ-SkZ8YbcP5o3ic975y7qRE0KucrJYVwfatBVStf7TfEJD4BdbzrH_YBjl81APuqJ5weYf5WdzCJTwBeoVE_qa7HaUP72aCJHsTrMTeWM1z6U47RkmTKQam0pAfn_xV9_vYVasy6xy3SeIxY5WCQB2Qe_Ej0cTydXVR-J2KFZnZMPsS4T8DcXpDsvd6uYo3U0CRjYtiavNcaebrF43GYU0qIuyTGFjZ92qWn0q9mCF92Xt70pXz2y5PxR31J1KgYLB02wP1MbGpVnbJrIw" \ -H "App-Id: lL8mM9_EdRNqIkMDkRJNlg" \ -H "App-Secret: FACYQz_tXS12Zq4shniuuA" \ -H "Access-Token: a042816d06ffbb20160005d5ea1ae3d89d565158025a28b7476312fbf6754d5b69b0a699729169a28068218134878990e263f0a2cb0908c68a9abd627ba56c64" \ -H "Client-Request-Id: 13" \ -X POST "/api/v2/payments/check_funds"

curl -i  \ 
 -H "Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJkYXRhIjp7ImFtb3VudCI6MTAwLCJjdXJyZW5jeV9jb2RlIjoiR0JQIiwiYWNjb3VudCI6Ijg0NTcyNDg2In0sImV4cCI6MTcxMzk0MDM2OH0.UkjGZ6vqs1YO7P8nsUdwOCk5a_Uc0ZP9A3FpEV6BAgNfHRSa0Clm5HGJ7ZC19pEkFBoSQ-SkZ8YbcP5o3ic975y7qRE0KucrJYVwfatBVStf7TfEJD4BdbzrH_YBjl81APuqJ5weYf5WdzCJTwBeoVE_qa7HaUP72aCJHsTrMTeWM1z6U47RkmTKQam0pAfn_xV9_vYVasy6xy3SeIxY5WCQB2Qe_Ej0cTydXVR-J2KFZnZMPsS4T8DcXpDsvd6uYo3U0CRjYtiavNcaebrF43GYU0qIuyTGFjZ92qWn0q9mCF92Xt70pXz2y5PxR31J1KgYLB02wP1MbGpVnbJrIw" \ 
 -H "App-Id: lL8mM9_EdRNqIkMDkRJNlg" \ 
 -H "App-Secret: FACYQz_tXS12Zq4shniuuA" \ 
 -H "Access-Token: a042816d06ffbb20160005d5ea1ae3d89d565158025a28b7476312fbf6754d5b69b0a699729169a28068218134878990e263f0a2cb0908c68a9abd627ba56c64" \ 
 -H "Client-Request-Id: 13" \ 
 -X POST "/api/v2/payments/check_funds"

Example of request parameters

{"data":{"amount":100,"currency_code":"GBP","account":"84572486"},"exp":1574093211}

Example of response

{"data":{"session_secret":"J9nZdqgqUycptyXUczBU"}}

Request

POST /api/v2/payments/check_funds

Headers

Header	Type	Description
`Authorization`	string, required	JSON Web Token containing payload, signed using RSA256 and `application.private_key`. Can raise: AuthorizationMissing
`App-Id`	string, required	Application’s `app_id` from connection details tab. Can raise: OauthAppNotFound, CertificateNotFound
`App-Secret`	string, required	Application’s `app_secret` from connection details tab.
`Access-Token`	string, required	Token for which we are requesting info. Can raise: TokenMissing, TokenNotFound, TokenRevoked, TokenExpired
`Client-Request-Id`	string, optional	Request identifier. If present, it will be returned within `meta` field in response.

Unpacked Request Authorization

data

hash, required

Wrapper for the data.

amount

integer, required

Amount to checked for availability. Values greater than: 0

currency_code

string, required

Currency code of the amount to be checked. Can raise: UnknownCurrency

account

string, required

Account number used to identify the account for prospective payment.

exp

integer, required

The lifetime of the request in timestamp UTC format. Values greater than: Current time.

Response

Upon successful request, 200 status code will be returned. See ‘Related Errors’ table for other possibilities.

data

hash, required

Wrapper for the data.

session_secret

string, required

Session identifier in Salt Edge PSD2 Compliance.

Related Errors

Class	Code	Description
TokenMissing	400	This request cannot be performed without `Access_Token` header.
AuthorizationMissing	401	Authorization header is missing.
TokenNotFound	401	Token specified in request does not exist or cannot be retrieved.
TokenRevoked	401	Token specified in request is revoked and cannot be used anymore.
TokenExpired	401	Token specified in request is expired and cannot be used.
UnknownCurrency	404	Unknown Currency code
OauthAppNotFound	404	OAuth Application specified in request does not exist or cannot be retrieved.
CertificateNotFound	404	Certificate has no permissions.