api
api
Quick start
Home
Overview
Skills
Servicers
Tenants
Security model
Dev guide
Intro
User onboarding
Consuming data
Designing a tenant app
API
Sessions
Steps
Tokens
Accounts
Balances
Transactions
Payments
Consents
Catalogs
Errors
Powered by GitBook

Payments

Payment initiation and query.

post
Get payment

https://api.finqware.com/v1/payments/get
Request
Response
Request
Body Parameters
client_id
required
string
An identifier for your client app.
client_secret
required
string
A tenant app secret
credentials_id
required
string
A pointer to the payment object
access_token
required
string
An auth token for the payment object
Response
200: OK
Payment object successfully retrieved.
{
    "id": "d2b1f64c-1ad4-48ec-8bv4-d390aec80f8a",
    "amount": "44.0",
    "currency": "RON",
    "status": "payment_initiated",
    "consented_at": "2019-09-13T12:49:45Z",
    "initiated_at": "2019-09-13T12:50:02Z",
    "servicer_name": "X Bank",
    "native_id": "XYZ",
    "custom_id": "21302.GFX.53",
    "creditor_account_id": "RO92RNCB0002000000011122",
    "creditor_account_name": "Keith Richards",
    "creditor_account_currency": "RON",
    "creditor_account_scheme": "IBAN",
    "creditor_details": "test",
    "debtor_account_id": "RO77RNCB0002000000010001",
    "debtor_account_name": "",
    "debtor_account_currency": null,
    "debtor_account_scheme": "IBAN",
    "debtor_details": null,
    "payment_instruction": "Finqware-460",
    "remittance_information": null,
    "requested_execution_date": null
}
404: Not Found
Could not find a cake matching this query.
{
    "message": "Error message"
}

​

post
​

https://api.finqware.com/v1/payments/create
Initiates a payment pointed by the provided credentials_id.
Request
Response
Request
Body Parameters
client_id
required
string
An identifier for your client app.
client_secret
required
string
A tenant app secret.
credentials_id
required
string
A pointer to the payment object
access_token
required
string
An auth token for the payment object
Response
200: OK
Some PSD2 APIs return a URL for a final user-level approval.
// Berlin Group APIs
{
    "data": {
        "payment_url": "A URL for payment approval"
    },
    "status": "SESSION_ENDED"
}
​
// Open Banking UK APIs
{
    "data": {
        "payment_id": "An id for the initiated payment object"
    },
    "status": "SESSION_ENDED"
}
​
​
API - Previous
Transactions
Next - API
Consents
Last updated 11 months ago