API Reference
Payment Instruction

Retrieve all payment instructions

1min
code examples curl location globoff 'https //api fictive com/rest/api/accounts/{accountreference}/payment instructions' \\ \ header 'accept application/json' \\ \ header 'content type application/json'var myheaders = new headers(); myheaders append("accept", "application/json"); myheaders append("content type", "application/json"); var requestoptions = { method 'get', headers myheaders, redirect 'follow' }; fetch("https //api fictive com/rest/api/accounts/{accountreference}/payment instructions", requestoptions) then(response => response text()) then(result => console log(result)) catch(error => console log('error', error));require "uri" require "json" require "net/http" url = uri("https //api fictive com/rest/api/accounts/{accountreference}/payment instructions") https = net http new(url host, url port) https use ssl = true request = net http get new(url) request\["accept"] = "application/json" request\["content type"] = "application/json" response = https request(request) puts response read body import requests import json url = "https //api fictive com/rest/api/accounts/{accountreference}/payment instructions" payload = {} headers = { 'accept' 'application/json', 'content type' 'application/json' } response = requests request("get", url, headers=headers, data=payload) print(response text) responses \[ { "paymentinstructionreference" "0010j3o92yzym43op0", "status" "active", "currency" "gbp", "cartreference" "0010kcksyu72h5m3x0", "fulfilmentpaymentmappings" \[ { "fulfilments" \[ { "fulfilmentreference" "0010l00wascmkx7uo3", "fulfilmentstatus" "pending", "fulfilmenttype" "digital", "expecteddeliverydate" "2017 03 30t00 00 00", "suppliernotificationdate" "2017 03 27t00 00 00", "addressreference" "0010df5qfo4xk5h0l0", "datecreated" "2017 03 20t00 00 00", "datelastupdated" "2017 03 20t00 00 00", "customfulfilmentparameters" { "custom fulfilment param name 1" "custom fulfilment param value 1", "custom fulfilment param name 2" "custom fulfilment param value 2", "custom fulfilment param name 3" "custom fulfilment param value 3" } } ], "payments" \[ { "paymentreference" "0010h00wascmkx7uo3", "paymentdate" "2017 03 23t00 00 00", "paymentstatus" "pending", "datecreated" "2017 03 20t00 00 00", "datelastupdated" "2017 03 20t00 00 00", "vatamount" 20, "grossamount" 120, "netamount" 100, "custompaymentparameters" { "custom payment param name 1" "custom payment param value 1", "custom payment param name 2" "custom payment param value 2", "custom payment param name 3" "custom payment param value 3" } }, { "paymentreference" "0010o00wascmkx7uo3", "paymentdate" "2017 03 23t00 00 00", "paymentstatus" "completed", "datecreated" "2017 03 20t00 00 00", "datelastupdated" "2017 03 20t00 00 00", "vatamount" 20, "grossamount" 120, "netamount" 100, "custompaymentparameters" { "custom payment param name 1" "custom payment param value 1", "custom payment param name 2" "custom payment param value 2" } } ] } ], "custompaymentinstructionparameters" { "name" "value" } }, { "paymentinstructionreference" "0010jeeuhryuvow6u1", "status" "cancelled", "currency" "gbp", "cartreference" "0010kh8lbndwhw6he2", "fulfilmentpaymentmappings" \[ { "fulfilments" \[ { "fulfilmentreference" "0010l2iib42dmhhyi0", "fulfilmentstatus" "dispatched", "fulfilmenttype" "physical", "expecteddeliverydate" "2017 03 30t00 00 00", "suppliernotificationdate" "2017 03 27t00 00 00", "addressreference" "0010dyv7fpip51sjh2", "datecreated" "2017 03 20t00 00 00", "datelastupdated" "2017 03 20t00 00 00", "customfulfilmentparameters" { "custom fulfilment param name 1" "custom fulfilment param value 1", "custom fulfilment param name 2" "custom fulfilment param value 2", "custom fulfilment param name 3" "custom fulfilment param value 3" } } ], "payments" \[ { "paymentreference" "0010oehzl6izp6b7o2", "paymentdate" "2017 03 23t00 00 00", "paymentstatus" "maxrefunded", "datecreated" "2017 03 20t00 00 00", "datelastupdated" "2017 03 20t00 00 00", "vatamount" 20, "grossamount" 120, "netamount" 100, "custompaymentparameters" { "custom payment param name 1" "custom payment param value 1", "custom payment param name 2" "custom payment param value 2", "custom payment param name 3" "custom payment param value 3" } }, { "paymentreference" "0010op7h4qy734yxb1", "paymentdate" "2017 03 23t00 00 00", "paymentstatus" "completed", "datecreated" "2017 03 20t00 00 00", "datelastupdated" "2017 03 20t00 00 00", "vatamount" 20, "grossamount" 120, "netamount" 100, "custompaymentparameters" { "custom payment param name 1" "custom payment param value 1", "custom payment param name 2" "custom payment param value 2" } } ] } ], "custompaymentinstructionparameters" { "name" "value" } } ]// no content (no paymentinstructions) \[ { "paymentinstructionreference" "", "status" "", "currency" "", "description" "", "cartreference" "", "fulfilmentpaymentmappings" \[ { "fulfilments" \[ { "cartreference" "", "fulfilmentreference" "", "fulfilmentstatus" "", "fulfilmenttype" "", "expecteddeliverydate" "2021 09 21t05 33 22 3073453", "suppliernotificationdate" "2021 09 21t05 33 22 3073453", "addressreference" "", "datecreated" "2021 09 21t05 33 22 3073453", "datelastupdated" "2021 09 21t05 33 22 3073453", "customfulfilmentparameters" {} } ], "payments" \[ { "cartreference" "", "paymentreference" "", "paymentdate" "2021 09 21t05 33 22 432364", "paymentstatus" "", "datecreated" "2021 09 21t05 33 22 432364", "datelastupdated" "2021 09 21t05 33 22 432364", "vatamount" "", "grossamount" "", "netamount" "", "custompaymentparameters" {} } ] } ], "custompaymentinstructionparameters" {} } ]// not authorized // not found (no account) // internal server error
๐Ÿค”
Have a question?
Our super-smart AI,knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.

๏ปฟ