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
If created successfully, a 201 response gets returned and adds a location header
to the response which refers to the new created Application
.
Single application object
Error
Authentication information is missing or invalid
Forbidden
Not Acceptable
curl https://finix.sandbox-payments-api.com/applications \ -H "Content-Type: application/vnd.api+json" \ -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \ -X POST \ -d ' { "entity": { "business_address": { "city": "San Mateo", "country": "USA", "line1": "741 Douglass St", "line2": "Apartment 8", "postal_code": "94114", "region": "CA" }, "business_name": "Finix Flowers", "business_phone": "+1 (408) 756-4497", "business_tax_id": "123456789", "business_type": "LIMITED_LIABILITY_COMPANY", "dob": { "day": 27, "month": 5, "year": 1978 }, "doing_business_as": "Finix Flowers", "email": "user@example.org", "first_name": "John", "last_name": "Smith", "max_transaction_amount": 1200000, "personal_address": { "city": "San Mateo", "country": "USA", "line1": "741 Douglass St", "line2": "Apartment 7", "postal_code": "94114", "region": "CA" }, "phone": "1234567890", "tax_id": "123456789" }, "tags": { "application_name": "Finix Flowers" }, "user": "USpbnPYf1MMaYYtBqNsNzD6T" }'
{- "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": {
}
}
}
Return a collection of Applications
. If there are no Applications
,
an empty collection gets returned.
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": {
}
}
}