Customer Ledgers

Issue a Ledger

Once you have a customer created, you can go ahead an issue them with a ledger so you can start offering them services.

POST accounts/customers/create_ledger
Headers
Content-Type: application/json
Accept: application/json
Authorization: token {{token value from here}}

Parameters

Parameter Format Length Description
customer_id
Required
string 36 A unique reference for your newly created customer profile, will be used in future requests relating to this individual.
Acceptable Characters: a-z A-Z 0-9 , . - _
currency
Required
string 3 Ledger currency, an ISO 4217 3-digit code.
Acceptable Characters: a-z A-Z
primary_use
Required
array An array of tags the describe what the account will be used for
Acceptable Values: "investment", "deposit", "payments", "settlement", "float", "fee", "collateral", "escrow"
owner
Required
string 2-5 The owner of the account
Acceptable Characters: a-z A-Z , . - _
{
"customer_id":"859f4eef-6a53-4110-8757-371844df8e8c",
"currency":"gbp",
"primary_use":[
    "payments",
    "settlement"
],
"owner":"me"
}
                        

Response

Parameter Format Length Description
status int 1-2 The outcome of the request.
message string 0-100 Handy text describing the status for debugging.
data object
ledger_id string 36 A unique reference for your newly created ledger, will be used in future requests relating to this ledger.
customer_id string 36 A unique reference for your newly created customer profile, will be used in future requests relating to this individual.
active boolean 4-5 A true/false value to let you know if the account is active or not
status string 1-50 Describes the current status of the account
primary_use array An array of tags the describe what the account will be used for
owner string 2-5 The owner of the account
ledger_details object
name string 1-100 The account holders name
balance int 1-11 The current balance on this ledger at the time of the request in the currency returned.
currency string 3 Ledger currency, an ISO 4217 3-digit code.
sort_code string 6 The sort code associated with the account
account_number string 8 The account number associated with the account
iban string 16-34 Returned for EUR accounts, value that you can share with your customers to recieve payments.
bic_swift string 8-11 Returned for EUR accounts, value that you can share with your customers to recieve payments.
created string 24 The date and time at which the account was created
last_update string 24 The date and time at which the account details were last updated
{
"status":1,
"message":"Success",
"data":{
    "ledger_id":"5ea2a49b-d224-42fa-a695-ebc61381fe02",
    "customer_id":"5e865d53-669c-4bbe-be49-09494cffc19d",
    "active":true,
    "status":"ready",
    "primary_use":[
        "payments",
        "settlement"
    ],
    "owner":"me",
    "ledger_details":{
        "name":"Joe Bloggs",
        "balance":0,
        "sort_code":"040052",
        "account_number":"00459615",
        "iban":"GB22PAYR04005200459615",
        "bic_swift":"PAYRGB20XXX"
    },
    "created":"2020-04-24 08:34:35",
    "last_update":"2020-04-24 08:34:35"
}
}
Take note of the ledger_id generated in the response, this will be used in subsequent API calls pertaining to the ledger.

Enable/Disable Ledger

PUT /accounts/customers/ledgers/{{ledger_id}}
Headers
Content-Type: application/json
Accept: application/json
Authorization: token {{token value from here}}

Parameters

Parameter Format Length Description
active
Required
string 4-5 The status that you want to update the ledger too.
Acceptable Values: “true” “false”
{
    "active": false
}
                        

Response

Parameter Format Length Description
status int 1-2 The outcome of the request.
message string 0-100 Handy text describing the status for debugging.
customer_id string 36 A unique reference for the customer profile, to the ledger that is being enabled/disabled.
ledger_id string 36 A unique reference for the ledger you are editing.
{
    "status": 1,
    "message": "Success",
    "customer_id": "859f4eef-6a53-4110-8757-371844df8e8c",
    "ledger_id": "921rte4-7a22-5091-3741-37133j8d4s"
}

Transaction List

Use this request to get a list of transactions on a specific ledger_id, usually in order to display this information to your customers.

GET /accounts/customers/ledgers/transactions/{{ledger_id}}
Headers
Content-Type: application/json
Accept: application/json
Authorization: token {{token value from here}}

Parameters

Parameter Format Length Description
from_date datetime 0-19 The date you want your search results to start, in the format: YYYY-MM-DD HH:MM:SS
to_date datetime 0-19 The date you want your search results to start, in the format: YYYY-MM-DD HH:MM:SS
type string 14-18 The type of transaction taking place, we will typically respond with interal_transfer or faster_payment
Acceptable Values: "faster_payment" or "internal_transfer"
in_out string 2-3 The direction in which funds are being moved
Acceptable Values: "in" or "out"
https://qaapp2.acquired.com/accounts/customers/transactions/1837dccf-cb4d-40aa-95d7-16b57863ed43?from_date=&to_date=

Response

Parameter Format Length Description
status int 1-2 The outcome of the request.
message string 0-100 Handy text describing the status for debugging.
data object
total int 1-11 The count of the transactions being listed
list array
transaction_id string 0-36 A unique reference for a transaction
date_time string 36 The time at which a transaction took place
name string 1-100 The account holders name
account_number string 8 The account number associated with the account
sort_code string 6 Returned for GBP accounts, value that you can share with your customers to recieve payments.
iban string 16-34 Returned for EUR accounts, value that you can share with your customers to recieve payments.
bic_swift string 8-11 Returned for EUR accounts, value that you can share with your customers to recieve payments.
reference string 1-18 A description of the payment that will apear on the senders and recievers bank statements
amount string 1-11 The total value of the transaction
currency string 3 Ledger currency, an ISO 4217 3-digit code.
in_out string 2-3 The direction in which funds are being moved
type string 14-18 The type of transaction taking place, we will typically respond with interal_transfer or faster_payment
response_code int 1-3 Code describing the transaction results.
Acceptable Characters: 0-9
response_message string 1-100 Message describing the transaction results.
Acceptable Characters: 0-9 a-z A-z _ - ()[]{};~!@#$%^*,./\?:”’ +=`
{
"status":1,
"message":"Success",
"data":{
    "total":2,
    "list":[
    {
        "transaction_id":"9010ef5b-8b1a-484d-b27c-e9002dcd93d2",
        "date_time":"2020/01/05 12:12:54",
        "name":"Dave Bloggs",
        "account_number":"12345678",
        "sort_code":"400052",
        "reference":"testing",
        "amount":"200.00",
        "currency":"gbp",
        "in_out":"in",
        "type":"faster_payment"
        "response_code":"1",
        "response_message":"Transaction Success"
    },
    {
        "transaction_id":"9010ef5b-8b1a-484d-b27c-e9002dcd93d2",
        "date_time":"2020/01/05 12:12:58",
        "name":"Joe Bloggs",
        "account_number":"12345678",
        "sort_code":"040230",
        "reference":"testing reference",
        "amount":"100.00",
        "currency":"gbp",
        "in_out":"out",
        "type":"internal_transfer"
        "response_code":"1",
        "response_message":"Transaction Success"
    }
    ]
}
}
Note for EUR transactions we should return "iban" and "bic_swift" details in the transaction list instead of "account_number" and "sort_code".

Query a Transaction

Use this request to get more details about a specific transaction_id, usually in order to display this information to your customers.

GET /accounts/customers/ledgers/transactions/{transaction_id}}
Headers
Content-Type: application/json
Accept: application/json
Authorization: token {{token value from here}}

Parameters

Parameter Format Length Description
transaction_id string 0-36 A unique reference for a transaction
https://qaapp2.acquired.com/accounts/customers/ledgers/transactions/1837dccf-cb4d-40aa-95d7-16b57863ed43

Response

Parameter Format Length Description
status int 1-2 The outcome of the request.
message string 0-100 Handy text describing the status for debugging.
data object
transaction_id string 0-36 A unique reference for a transaction
date_time string 36 The time at which a transaction took place
name string 1-100 The account holders name
account_number string 8 The account number associated with the account
sort_code string 6 Returned for GBP accounts, value that you can share with your customers to recieve payments.
iban string 16-34 Returned for EUR accounts, value that you can share with your customers to recieve payments.
bic_swift string 8-11 Returned for EUR accounts, value that you can share with your customers to recieve payments.
reference string 1-18 A description of the payment that will apear on the senders and recievers bank statements
amount string 1-11 The total value of the transaction
currency string 3 Ledger currency, an ISO 4217 3-digit code.
in_out string 2-3 The direction in which funds are being moved
type string 14-18 The type of transaction taking place, we will typically respond with interal_transfer or faster_payment
response_code int 1-3 Code describing the transaction results.
Acceptable Characters: 0-9
response_message string 1-100 Message describing the transaction results.
Acceptable Characters: 0-9 a-z A-z _ - ()[]{};~!@#$%^*,./\?:”’ +=`
{
"status": "1", 
"message": "Success",
"data": {
        "transaction_id": "9010ef5b-8b1a-484d-b27c-e9002dcd93d2",
        "date_time": "2020/01/05 12:12:54",
        "name": "Steve Ryan",
        "account_number": "12345678",
        "sort_code": "400052",
        "reference": "testing",
        "amount": "200.00",
        "currency": "gbp",
        "in_out": "in",
        "type": "faster_payment",
        "response_code":"1",
        "response_message":"Transaction Success"
        }
}
Note for EUR transactions we should return "iban" and "bic_swift" details in the transaction list instead of "account_number" and "sort_code".

Ledger Details

Use this request to get an overview of a specific ledger_id, usually in order to display this information to your customers.

GET /accounts/customers/ledgers/{{ledger_id}}
Headers
Content-Type: application/json
Accept: application/json
Authorization: token {{token value from here}}

Response

Parameter Format Length Description
status int 1-2 The outcome of the request.
message string 0-100 Handy text describing the status for debugging.
data object
ledger_id string 36 A unique reference for your newly created ledger, will be used in future requests relating to this ledger.
customer_id string 36 A unique reference for your newly created customer profile, will be used in future requests relating to this individual.
active boolean 4-5 A true/false value to let you know if the account is active or not
status string 1-50 Describes the current status of the account
primary_use array An array of tags the describe what the account will be used for
owner string 2-5 The owner of the account
ledger_details object
name string 1-100 The account holders name
balance int 1-11 The current balance on this ledger at the time of the request in the currency returned.
currency string 3 Ledger currency, an ISO 4217 3-digit code.
sort_code string 6 The sort code associated with the account
account_number string 8 The account number associated with the account
iban string 16-34 Returned for EUR accounts, value that you can share with your customers to recieve payments.
bic_swift string 8-11 Returned for EUR accounts, value that you can share with your customers to recieve payments.
created string 24 The date and time at which the account was created
last_update string 24 The date and time at which the account details were last updated
{
    "status": 1,
    "message": "Success",
    "data": {
        "ledger_id": "5e71546a-523b-4de0-b649-a4c8f1165e85",
        "customer_id": "5e7151c5-7038-4e60-a644-1609408d96a8",
        "active": true,
        "status": "ready",
        "primary_use": [
            "payments",
            "settlement"
        ],
        "owner": "other",
        "ledger_details": {
            "name": "Joe Bloggs",
            "balance": 9438.99,
            "sort_code": "040052",
            "account_number": "00453920",
            "iban": "GB42PRYR04005200453920",
            "bic_swift": "PAYRFB20XXX"
        },
        "created": "2020-03-17 22:51:22",
        "last_update": "2020-03-17 22:51:22"
    }
}
Note for EUR transactions we should return "iban" and "bic_swift" details in the transaction list instead of "account_number" and "sort_code".