The Application
resource represents your app. This could be an iOS app, a website, an online marketplace, a SaaS platform, etc. Any web service that connects buyers (i.e. customers) and sellers (i.e. merchants).
In other words, an Application
is a resource that represents the program you're integrating with Finix and using to connect with customers (i.e. buyers).
Related Guides: Your Account, Key Resources and Account Structure
Return a collection of Applications
. If there are no Applications
,
an empty collection gets returned.
id | string Filter by |
before_cursor | string Return every resource created before the cursor value. |
after_cursor | string Return every resource created after the cursor value. |
limit | integer The numbers of items to return. Example: limit=10 |
tags.key | string Filter by the |
tags.value | string Filter by the value of a |
List of Applications
.
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl https://finix.sandbox-payments-api.com/applications \ -H "Content-Type: application/vnd.api+json" \ -u USimz3zSq5R2PqiEBXY6rSiJ:8bacba32-9550-48ff-b567-fe7648947041
{- "_embedded": {
- "applications": [
- {
- "id": "APdoThHn4jjYUSxQf76txAgg",
- "created_at": "2022-09-20T23:03:21.74Z",
- "updated_at": "2022-09-20T23:03:21.74Z",
- "card_cvv_required": false,
- "card_expiration_date_required": true,
- "creating_transfer_from_report_enabled": false,
- "enabled": true,
- "fee_ready_to_settle_upon": "RECONCILIATION",
- "name": "Abhishek Test",
- "owner": "IDpxUfpKm1UCqtx5N4SkqVr5",
- "processing_enabled": true,
- "ready_to_settle_upon": "RECONCILIATION",
- "settlement_enabled": true,
- "settlement_funding_identifier": "UNSET",
- "tags": { },
- "_links": {
- "processors": {
}, - "users": {
}, - "owner_identity": {
}, - "transfers": {
}, - "disputes": {
}, - "authorizations": {
}, - "settlements": {
}, - "merchants": {
}, - "identities": {
}, - "webhooks": {
}, - "reversals": {
}, - "tokens": {
}, - "payment_instruments": {
}, - "application_profile": {
}
}
}, - {
- "id": "APrpAfFbr9TqMw1FXLAD6vNg",
- "created_at": "2022-04-29T00:48:15.01Z",
- "updated_at": "2022-04-29T00:48:16.56Z",
- "card_cvv_required": false,
- "card_expiration_date_required": true,
- "creating_transfer_from_report_enabled": false,
- "enabled": true,
- "fee_ready_to_settle_upon": "RECONCILIATION",
- "name": "BrainTree",
- "owner": "IDfEzc4SsQkk1FN516DDQWuj",
- "processing_enabled": true,
- "ready_to_settle_upon": "RECONCILIATION",
- "settlement_enabled": true,
- "settlement_funding_identifier": "UNSET",
- "tags": {
- "application_name": "BrainTree"
}, - "_links": {
- "processors": {
}, - "users": {
}, - "owner_identity": {
}, - "transfers": {
}, - "disputes": {
}, - "authorizations": {
}, - "settlements": {
}, - "merchants": {
}, - "identities": {
}, - "webhooks": {
}, - "reversals": {
}, - "tokens": {
}, - "payment_instruments": {
}, - "application_profile": {
}
}
}
]
}, - "_links": {
}, - "page": {
- "offset": 0,
- "limit": 20,
- "count": 110412
}
}
Retrieve the details of an Application
.
Single application object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
{- "id": "APgPDQrLD52TYvqazjHJJchM",
- "created_at": "2022-01-27T07:36:33.59Z",
- "updated_at": "2022-01-27T07:44:04.94Z",
- "card_cvv_required": false,
- "card_expiration_date_required": true,
- "creating_transfer_from_report_enabled": true,
- "enabled": true,
- "fee_ready_to_settle_upon": "RECONCILIATION",
- "name": "BrainTree",
- "owner": "IDuquemzE7UkUJioGJfVKBKt",
- "processing_enabled": true,
- "ready_to_settle_upon": "RECONCILIATION",
- "settlement_enabled": true,
- "settlement_funding_identifier": "UNSET",
- "tags": {
- "application_name": "BrainTree"
}, - "_links": {
- "processors": {
}, - "users": {
}, - "owner_identity": {
}, - "transfers": {
}, - "disputes": {
}, - "authorizations": {
}, - "settlements": {
}, - "merchants": {
}, - "identities": {
}, - "webhooks": {
}, - "reversals": {
}, - "tokens": {
}, - "payment_instruments": {
}, - "application_profile": {
}
}
}
Update an existing Application
.
Single application object
Authentication information is missing or invalid
Forbidden
Object does not exist
Not Acceptable
curl https://finix.sandbox-payments-api.com/applications/APgPDQrLD52TYvqazjHJJchM \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \ -X PUT \ -d ' { "tags": { "application_name": "Finix Flowers" } }'
{- "id": "APgPDQrLD52TYvqazjHJJchM",
- "created_at": "2022-01-27T07:36:33.59Z",
- "updated_at": "2022-01-27T07:44:04.94Z",
- "card_cvv_required": false,
- "card_expiration_date_required": true,
- "creating_transfer_from_report_enabled": true,
- "enabled": true,
- "fee_ready_to_settle_upon": "RECONCILIATION",
- "name": "BrainTree",
- "owner": "IDuquemzE7UkUJioGJfVKBKt",
- "processing_enabled": true,
- "ready_to_settle_upon": "RECONCILIATION",
- "settlement_enabled": true,
- "settlement_funding_identifier": "UNSET",
- "tags": {
- "application_name": "BrainTree"
}, - "_links": {
- "processors": {
}, - "users": {
}, - "owner_identity": {
}, - "transfers": {
}, - "disputes": {
}, - "authorizations": {
}, - "settlements": {
}, - "merchants": {
}, - "identities": {
}, - "webhooks": {
}, - "reversals": {
}, - "tokens": {
}, - "payment_instruments": {
}, - "application_profile": {
}
}
}