Skip to main content

Scopes

  • Account Information🔒
  • Payment Initiation🔒

Live Environment

Precondition:To connect to Mettle Bank, an application needs to be created. Once the application is created a client_id and client_secret are generated. Pre-requisites for Registration:
  1. Valid QWAC / QSEAL certificates.
  2. Upload the signing (QSEAL) and transport (QWAC) certificates into V2 services
Request format:
  • Where pem and key need to be in the following format: -----BEGIN PRIVATE KEY-----\n KEY_HASH\n MORE_KEY_HASH\n SOME_MORE_KEY_HASH\n -----END PRIVATE KEY-----
Please note:
  1. Spaces between “begin/end private key” words are respected.
  2. Begin/End Private Key are included in the value for thepemandkeyproperties.
  3. Every line break is escaped with a “\n”.
  4. There is NO “\n” at the end.
Response format:
  • Once you have uploaded your certificates successfully, you will receive a response containing an “id”. Please make sure that you save them and note to which certificates they belong.
If the Certificates have already been uploaded: Then, it can be retrieved from the endpoint: GET 'https://api.yapily.com/certificates/keys/' Response format:

Registration

  • Use the following request to register any Mettle institution with Yapily.
Where:
  • INSTITUTION_ID is the Yapily institution id.
  • SIGNING_KEY_UUID and TRANSPORT_KEY_UUID are the “ids” that you saved before when uploading the certificates (signing and transport).
  • client_id_from_created_application and client_secret_from_created_application are valid credentials for the Mettle developer portal.
Response format:
  • The response from the registration call should also contain an “id”, which would mean that the registration was successful. Please save that “id” and note to which bank it belongs.

Sandbox Environment

Not available at the moment

Support

If you require technical support with certificate management, please contact Support.