Create Faster Payment

POST /customer/transactions

Parameters: No parameters

Request body:

To create internal payment use creditor_account_id, to create external payment use beneficiary_id instead of creditor_account_id

Example Value
Schema

{
  "amount": "string",
  "reference": "string",
  "debtor_account_id": "string",
  "creditor_account_id": "string",
  "beneficiary_id": "string"
}

Responses:

200

Example Value

Controls
Accept
Header

{
  "transactionId": "string"
}

400

Example Value

Controls
Accept
Header

Bad request

401

Example Value

Controls
Accept
Header

Unauthorized

Get all transactions by ledger id

GET /customer/transactions Returns all transaction by ledger id. By default limit of transactions is 5. To use pagination use query string parameters - limit and LastEvaluatedKeyCreatedAt (from response LastEvaluatedKey.created_at).

Parameters: No parameters

Request body:

200

Responses:

200

Example Value

Controls
Accept
Header

{
  "transactions": [
    {
      "createdAt": "string",
      "id": "string",
      "assetType": "string",
      "transactionStatus": "string",
      "transaction_id": "string",
      "transactionType": "string",
      "reference": "string",
      "creditor": {
        "BBAN": "string",
        "IBAN": "string",
        "InstitutionName": "string",
        "AccountName": "string"
      },
      "iban": "string",
      "amount": "string",
      "details": {
        "Status": "string",
        "Account": {
          "BBAN": "string",
          "IBAN": "string",
          "InstitutionName": "string",
          "AccountName": "string"
        },
        "Scheme": "string",
        "DebitCreditCode": "string",
        "Reference": "string",
        "Amount": "string",
        "TransactionId": "string",
        "IsReturn": "string",
        "CurrencyCode": "string",
        "EndToEndTransactionId": "string",
        "CounterpartAccount": {
          "BBAN": "string",
          "IBAN": "string",
          "InstitutionName": "string",
          "AccountName": "string"
        },
        "TimestampModified": "string",
        "ActualEndToEndTransactionId": "string"
      }
    }
  ],
  "LastEvaluatedKey": {
    "ledgerId": "string",
    "created_at": "string"
  }
}

400

Example Value

Controls
Accept
Header

Bad request

401

Example Value

Controls
Accept
Header

Unauthorized

Create International Payment

POST /customer/transactions/mccy/outbound

Parameters: No parameters

Request body:

Example Value
Schema

{
  "ledgerId": "string",
  "amount": 0,
  "reference": "string",
  "creditor": {
    "name": "string",
    "iban": "string",
    "bic": "string",
    "accountNumber": "string",
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "postCode": "string",
      "country": "string"
    }
  },
  "creditorAgent": {
    "FinancialInstitutionIdentification": {
      "bic": "string",
      "name": "string",
      "addressDetails": {
        "addressLine1": "string",
        "addressLine2": "string",
        "postCode": "string",
        "country": "string"
      }
    }
  }
}

{
  "ledgerId": "string",
  "amount": 0,
  "reference": "string",
  "creditor": {
    "name": "string",
    "iban": "string",
    "bic": "string",
    "accountNumber": "string",
    "address": {
      "addressLine1": "string",
      "addressLine2": "string",
      "postCode": "string",
      "country": "string"
    }
  },
  "creditorAgent": {
    "FinancialInstitutionIdentification": {
      "bic": "string",
      "name": "string",
      "addressDetails": {
        "addressLine1": "string",
        "addressLine2": "string",
        "postCode": "string",
        "country": "string"
      }
    }
  }
}

Responses:

200

Example Value

Controls
Accept
Header

{
  "transactionId": "string"
}

400

Example Value

Controls
Accept
Header

Bad request

401

Example Value

Controls
Accept
Header

Unauthorized