Create Payments

The Create Payment operation allows you to initiate an outbound payment from a Fondy account to a counterparty. This operation requires the provision of counterparty details, the payment amount, a payment reference, and the payment type (currently, only fasterpayments and internal are supported). Additionally, the account details for the payee or counterparty must be provided.

This page will guide you through using this operation. See the following sections for more details.

🚧

Encrypted Requests

All requests into the stack are performed using the Encrypted Endpoint, where the request and response of the operation are encrypted. See How to Integrate Fondy API to learn how to encrypt your operations and send them through the endpoint.

Request

The request process of this operation consists of the following two steps:

1. Create the payload
2. Make the encrypted request

See the sections below for more details on each step.

Step 1: Create the payload

The information on the account must be sent to the payload. See the code block below for an example:

{
  "counterparty": {
    "account_number": 12345678,
    "name": "ExampleCounterparty",
    "sort_code": 35648,
    "bic": 35648,
    "iban": "12312312",
    "address": {
      "country_code": "England",
      "city": "London",
      "street": "Street",
      "building_name": "1",
      "building_number": "2",
      "postal_code": "11223"
    }
  },
  "requested_amount": {
    "currency": "GBP",
    "amount": 99
  },
  "payment_references": {
    "payment_reference": "11122223333"
  }
}
'

Where:

Once you create the payload, it has to be encrypted. See the following section for more details.

Step 2: Make the encrypted request

To create the Fondy account, follow the steps below:

1. Follow the steps in How to Integrate Fondy API to encrypt your request into the stack.
2. Send the encrypted operation using Encrypted Endpoint. See an example in the code block below:
   Request

   {
       "encrypted_payload": ENCRYPTED(walletObject),
       "encrypted_user": ENCRYPTED(<username>),    
       "encrypted_url": ENCRYPTED("/account"),
       "method": "POST"
   }
   

In the request ENCRYPTED(walletObject) is the payload previously created, which is now encrypted.

Response

A successful request will return the encrypted response, as in the code block below:

{
    "encrypted_payload": ENCRYPTED(accountObject)
    "encrypted_url": null
    "method": null
    "nonce": null
}

This response has to be decrypted using the process explained in How to Integrate Fondy API. Once it is decrypted, the unencrypted payload is as follows:

curl --request POST \
     --url https://api.fondy.io/clientapi/api/version/clientRef/base64user/accounts \
     --header 'accept: */*' \
     --header 'content-type: application/json' \
     --data '
{
  "account_type": "MASTER",
  "account_currency": "GBP",
  "account_balance": {
    "currency": "GBP",
    "amount": 4500
  },
  "account_details": {
    "name": "Example",
    "iban": "FR7630006000011234567890189",
    "sort_code": "012345",
    "account_number": "01234567"
  },
  "external_id": "ExampleRefId_43971e26-61b1-420b-9add-c510d44a354f",
  "classification": "SOLE_TRADER",
  "created_date_time": "2020-01-22T13:15:30.000Z",
  "updated_date_time": "2020-01-22T13:15:30.000Z",
  "master_account_id": "f8605015-90ac-4450-bb99-cbb1591bce7a",
  "id": "f8605015-90ac-4450-bb99-cbb1591bce7a",
  "wallet_account_id": "f8605015-90ac-4450-bb99-cbb1591bce7a",
  "account_alias": "Example123",
  "status": "ACTIVE",
  "default_wallet": true
}
'

Where: