Skip to main content
GET
/
bank-payments
/
{id}
Get a bank payment
const options = {method: 'GET'};

fetch('https://api.dolfinai.co/bank-payments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "institutionId": "<string>",
  "amount": 123,
  "currency": "<string>",
  "reference": "<string>",
  "payeeName": "<string>",
  "supplierId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "yapilyStatus": "<string>",
  "isoStatus": "<string>",
  "multiAuthorisationStatus": "<string>",
  "multiAuthorisationsRequired": 123,
  "multiAuthorisationsReceived": 123,
  "authorisationUrl": "<string>",
  "authorisationExpiresAt": "2023-11-07T05:31:56Z",
  "errorMessage": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "executedAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "failedAt": "2023-11-07T05:31:56Z"
}

Path Parameters

​
id
string<uuid>
required

Response

OK

​
id
string<uuid>
required
​
billId
string<uuid>
required
​
status
enum<string>
required
Available options:
Initiating,
AwaitingAuthorisation,
Authorised,
Pending,
Completed,
Failed,
Expired
​
institutionId
string
required
​
amount
required
​
currency
string
required
​
reference
string
required
​
payeeName
string
required
​
supplierId
null | string<uuid>
​
yapilyStatus
null | string
​
isoStatus
null | string
​
multiAuthorisationStatus
null | string
​
multiAuthorisationsRequired
​
multiAuthorisationsReceived
​
authorisationUrl
null | string
​
authorisationExpiresAt
null | string<date-time>
​
errorMessage
null | string
​
createdAt
string<date-time>
​
executedAt
null | string<date-time>
​
completedAt
null | string<date-time>
​
failedAt
null | string<date-time>