Transactions

Inter-ledger Transfers

Use this to transfer money between your accounts or to your customers’ ledgers.

POST /accounts/internal_transfer

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

Parameters

Parameter	Format	Length	Description
from_ledger_id Required	`string`	36	The ledger from which funds are being transferred. Acceptable Characters: a-z A-Z 0-9 –
to_ledger_id Required	`string`	36	The ledger to which funds are being transferred. Acceptable Characters: a-z A-Z 0-9 –
amount Required	`string`	1-11	The amount you want to transfer. Acceptable Characters: 0-9 .
reference Required	`string`	1-18	A description of the payment that will appear on your ledger and the customer's ledger (if sending funds to one). Acceptable Characters: a-z A-Z 0-9 _ –

JSON

{
    "from_ledger_id": "6cf0fed2-fa2c-4145-876f-38091fddcb1d",
    "to_ledger_id": "a303519e-3b65-4a1e-b8b9-b480ade983f7",
    "amount": "200",
    "reference": "Internal Transfer"
}

Response

Parameter	Format	Length	Description
status	`int`	1-2	The outcome of the request.
message	`string`	0-100	Handy text describing the response_code or error for debugging. The possible response codes and associated messages are as follows: 1 - success 12 - quarantined 101 - declined 650 - insufficient_funds 651 - compliance_firewall 606 - contact_support
response_code	`string`	1-3	Numeric value to indicate the outcome of the transfer. The possible response codes and associated messages are as follows: 1 - success 12 - quarantined 101 - declined 650 - insufficient_funds 651 - compliance_firewall 606 - contact_support
transaction_id	`int`	36	Unique ID we generate to identify the transaction.

JSON

{
    "status":1,
    "message":"success",
    "response_code":"1",
    "transaction_id":"22938286-283a-4594-b21c-afb1bd52d22c"
}

Process a Payout

Use this to send money to a beneficiary .

POST /accounts/customer/pay_out

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

Parameters

Parameter	Format	Length	Description
beneficiary_id Required	`string`	36	The unique customer profile reference returned to you as part of the `create_beneficiary` process. Acceptable Characters: a-z 0-9 -
reference Required	`string`	1-18	A description of the payment that will appear on your ledger and the customer's ledger (if sending funds to one). Acceptable Characters: a-z A-Z 0-9 _ –
amount Required	`string`	1-11	The amount you want to payout. Acceptable Characters: 0-9 .

JSON

{
    "beneficiary_id": "22938286-283a-4594-b21c-afb1bd52d22c",
    "reference": "Example Reference",
    "amount": "200"
}

Response

Parameter	Format	Length	Description
status	`int`	1-2	The outcome of the request.
message	`string`	0-100	Handy text describing the response_code or error for debugging. The possible reponse codes and associated message's are as follows: 1 - success 12 - quarantined 101 - declined 650 - insufficient_funds 651 - compliance_firewall 606 - contact_support
response_code	`string`	1-3	Numeric value to indicate the outcome of the transfer. The possible reponse codes and associated message's are as follows: 1 - success 12 - quarantined 101 - declined 650 - insufficient_funds 651 - compliance_firewall 606 - contact_support
transaction_id	`int`	36	Unique ID we generate to identify the transaction.

JSON

{
    "status":1,
    "message":"success",
    "response_code":"1",
    "transaction_id":"22938286-283a-4594-b21c-afb1bd52d22c"
 }

<<<<<<< HEAD =======

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/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/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 holder's 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 receive payments.
iban	`string`	16-34	Returned for EUR accounts, value that you can share with your customers to receive payments.
bic_swift	`string`	8-11	Returned for EUR accounts, value that you can share with your customers to receive payments.
reference	`string`	1-18	A description of the payment that will appear on the senders and receivers 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 internal_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 _ - ()[]{};~!@#$%^*,./\?:”’ +=`

JSON

{
"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"
        }
}

Please note - For EUR transactions we should return "iban" and "bic_swift" details in the transaction list instead of "account_number" and "sort_code".

>>>>>>> ea691d684ab0152adf6735a96003a4fe40d55713