Download OpenAPI specification:Download
API for integrating a store with etika to provide your customers with interest free loans.
All requests must include both an api token and a business id.
This flow provisions an order in the etika platform, captures the required customer information to allow etika to make a decision on there application and finally commences the customers loan and settles the payment with the merchant.
https://portal.au.etika.com/checkout/express/#/?oid={orderToken}
.confirm
, they will be returned to the redirectConfirmUrl
provided in the Create order request.cancel
, they will be returned to the redirectCancelUrl
provided in the Create order request.DECLINED
and the click continue
, they will be returned to the redirectDeclinedUrl
provided in the Create orderrequest.APPROVED
or DECLINED
) is only known once Create Payment has been completed.When creating/updating a resource using the API, all POST
/PUT
/PATCH
actions can be initiated with a x-pb-request-id
header with a unique
string for that request.
Any request that returns a 2XX status code will only be created/updated
once, and can be safely repeated for at least 20 minutes. A response
that returns a 5XX but is expected to return a 2XX and was initiated
with a x-pb-request-id
header, can safely be repeated until a 2XX
status code is recieved.
We recommend that a GUID or other high entropy value (such as a SHA-1 hash) is used to decrease the chances of a collision.
A health check endpoint to allow dependant services to check the status of the service. If the service is healthy, a 200 status code will be returned. Any other response is considered unhealthy.
This can be used to verify that the system is active and ready to receive requests. This endpoint is throttled to one request every 10 seconds but can be called as part of your monitoring if required.
{- "status": "OK"
}
Fetch Products of the requesting tenant. Lists available products that can be provided by the corresponding business and api-token.
[- {
- "alias": "DEFAULT",
- "effectiveFrom": "2030-01-01",
- "effectiveTo": "2040-01-01",
- "status": "ACTIVE",
- "type": "BNPL",
- "description": "Buy now and pay later with 2, 4 or 8 interest free repayments over 8 weeks.",
- "maximumAmount": {
- "amount": "22.50",
- "currency": "AUD"
}, - "minimumAmount": {
- "amount": "22.50",
- "currency": "AUD"
}, - "featureSet": {
- "contributions": false,
- "refunds": false
}
}
]
Creates an order based on the provided details. This is the first step in allowing your customer to checkout with etika. Calling this endpoint will return a token that can later be used to accept the payment.
x-pb-request-id | string Example: ba8e486b-41fa-48d5-8bf3-979c3fe08131 Idempotency token. See how we handle idempotent requests for more information. |
required | object The total of this order including shipping, taxes, and after applying all discounts. |
object The total taxes on this Order. | |
object The cost of shipping on this Order | |
product required | string <= 255 characters Default: "DEFAULT" Value: "DEFAULT" The type of payment product that is going to be offered to your customer as part of their checkout experience. See your merchant portal for information on what products are available to you. |
object The consumer that is submitting this order. | |
object The billing address nominated by the consumer. | |
object Shipping address of the consumer. This is required primarily to assist with dispute resolution. | |
required | object (MerchantMeta) Details about the order provided by the merchant. |
required | Array of objects (Item) non-empty A list of line items comprising this order. |
Array of objects (Discount) A list of discounts that were applied to this order |
{- "product": "DEFAULT",
- "totalAmount": {
- "amount": "40.70",
- "currency": "AUD"
}, - "items": [
- {
- "name": "Shirt X-Large - Gray",
- "sku": "11359091",
- "quantity": 2,
- "price": "40.70"
}
], - "merchant": {
- "reference": "reference-1234"
}
}
{- "token": "9e1ea67a-cc03-4d5e-905d-2e89a4dd3042",
- "expires": "2029-01-01T12:00:00.000Z"
}
Fetches the order based on the token
token required | string Example: f353a9e0-c32a-11e9-a28d-6bc050273bae The token for the Payment |
{- "product": "BNPL",
- "consumer": {
- "phoneNumber": "+61412345678",
- "givenNames": "John",
- "surname": "Consumer",
- "email": "test@etika.com"
}, - "billing": {
- "name": "John Consumer",
- "line1": "Level 9",
- "line2": "222 Exhibition Street",
- "suburb": "Melbourne",
- "state": "VIC",
- "postcode": "3000",
- "countryCode": "AU",
- "phoneNumber": "+61412345678"
}, - "shipping": {
- "name": "John Consumer",
- "line1": "Level 9",
- "line2": "222 Exhibition Street",
- "suburb": "Melbourne",
- "state": "VIC",
- "postcode": "3000",
- "countryCode": "AU",
- "phoneNumber": "+61412345678"
}, - "items": [
- {
- "name": "T-Shirt",
- "sku": "12341234",
- "quantity": 1,
- "price": {
- "amount": "10.00",
- "currency": "AUD"
}
}, - {
- "name": "Jeans",
- "sku": "12341235",
- "quantity": 1,
- "price": {
- "amount": "20.00",
- "currency": "AUD"
}
}
], - "discounts": [
- {
- "reference": "10% Off Subtotal",
- "amount": {
- "amount": "3.00",
- "currency": "AUD"
}
}
], - "merchant": {
- "reference": "merchantOrder-1234"
}, - "taxAmount": {
- "amount": "3.70",
- "currency": "AUD"
}, - "shippingAmount": {
- "amount": "10.00",
- "currency": "AUD"
}, - "totalAmount": {
- "amount": "40.70",
- "currency": "AUD"
}, - "token": "9e1ea67a-cc03-4d5e-905d-2e89a4dd3042",
- "expires": "2029-01-01T12:00:00.000Z"
}
Create a payment from an existing Order. This action can only be taken after the user has returned from confirming the Order by logging into their etika account otherwise the request will be denied.
x-pb-request-id | string Example: ba8e486b-41fa-48d5-8bf3-979c3fe08131 Idempotency token. See how we handle idempotent requests for more information. |
token required | string <guid> A unique token that is returned when creating an order and can be used to confirm payment, after the consumer has been approved for the loan, for the associated order. |
{