Logo
Acquired.com API API Documentation

Acquired.com

Number of APIs: 34


1. Customers - Create a customer

POST {{url}}customers

The purpose of creating a customer is so that everything can be linked back to a customer_id. All transactions, payees, cards etc. are associated to a customer.

Creating a customer at the start of the process allows us to manage your customers for you.

https://docs.acquired.com/reference/create-customer



2. Customers - List all customers

GET {{url}}customers

Returns a list of all customers. Customers are returned by creation date, with the most recently created customers showing first.

https://docs.acquired.com/reference/fetch-all-customers



3. Customers - Retrieve a customer

GET {{url}}customers/:customer_id

Retrieves a customer using the unique customer_id. This identifier can be found in the response after creating a new customer.

https://docs.acquired.com/reference/fetch-customer-by-id



4. Customers - Update a customer

PUT {{url}}customers/:customer_id

This request allows you to update any details of the customer using the customer_id. You can choose to update certain parameters, any parameters not provided will be left unchanged.

https://docs.acquired.com/reference/update-customer



5. Cards - Get customer cards

GET {{url}}customers/:customer_id/cards

Retrieve a list of all cards belonging to a customer. All cards are associated to the customer_id.

https://docs.acquired.com/reference/fetch-customer-cards



6. Cards - List all cards

GET {{url}}cards

Returns a list of all cards. Cards are returned by creation date, with the most recently created customers showing first.

https://docs.acquired.com/reference/fetch-all-cards



7. Cards - Get card details

GET {{url}}cards/:card_id

Retrieve all the details of a specified card, by appending the relating card_id to the URL.

https://docs.acquired.com/reference/fetch-cards-by-id



8. Cards - Update card details

PUT {{url}}cards/:card_id

This allows you to update specific details about a card, such as expiry date or cardholder name, without having to re-enter and update all the card details. Just pass the updated parameters in your request, any parameters not returned will be left unchanged.

https://docs.acquired.com/reference/update-card-details



9. Payments - Process a payment

POST {{url}}payments

Submit a payment request into the API and receive a response. If you want to create a card for future use, submit the full card details within the card object and set the create_card parameter to true. Make sure that you add the relating customer_id as all payments and cards must be associated to the customer. The newly created card_id value will then be returned in the response, and can be passed in the card_id parameter in the /payments/reuse or /payments/recurring endpoint.

https://docs.acquired.com/reference/create-payment



10. Payments - Process a payment (card_id)

POST {{url}}payments/reuse

Process a payment using a stored card. Simply pass the card_id and the cvv value in your request instead of passing the full card details. You are not required to pass the customer_id in the request as the card is linked to the required customer.

https://docs.acquired.com/reference/create-payment-stored-card



11. Payments - Apple Pay

POST {{url}}payments/apple-pay

When the user selects the Apple Pay button a payment request will be created and an encrypted payload will be returned to us.

https://docs.acquired.com/docs/apple-pay



12. Payments - Google Pay

POST {{url}}payments/google-pay

When the user selects to pay with Google Pay, a payment request will be created and an encrypted payload will be returned to your application.

https://docs.acquired.com/docs/google-pay



13. Payments - Recurring payments

POST {{url}}payments/recurring

Recurring payments can be used to charge customers on a regular basis, i.e. for subscriptions or credit-based services.

https://docs.acquired.com/reference/create-recurring-payment



14. Hosted Checkout - Payment link (customer_id)

POST {{url}}payment-links

https://docs.acquired.com/docs/introduction-to-checkout

The easiest way to start accepting eCommerce payments. Prebuilt and fully hosted by Acquired.com to get all of our supported payment methods in front of your customers.

For existing customers, provide a customer_id in the initial payment links request without the need to pass the full card details. If the 'save cards' feature is enabled within the Hub, cards will also be saved against the customer_id.

Append the link_id to our known URLs and open in a browser - https://test-pay.acquired.com/v1/{{link_id}}

Enter the cardnumber 4000015979612025 to replicate a 3-D Secure checkout flow where the cardholder is required to authenticate themselves.



15. Payment Methods - Create a merchant-session (Apple Pay)

POST {{url}}payment-methods/apple-pay/session

For every new Apple Pay payment request you receive a session object. You must validate your merchant identity in order to generate the merchant-session.

https://docs.acquired.com/docs/apple-pay-on-web

You must add your domain in the Acquired.com Hub (https://qahub.acquired.com) before using this request.



16. Pay by Bank - List all supported banks

GET {{url}}aspsps

If you would like to create your own UI for account selection this can be used to retrieve a list of banks Acquired.com currently support. This includes names, logos and support services.

https://docs.acquired.com/reference/fetch-aspsp

https://docs.acquired.com/docs/build-your-own-ui-1



17. Pay by Bank - Process a payment

POST {{url}}single-immediate-payment

Request consent from the ASPSP and generate a URL for the user to authenticate themselves.

https://docs.acquired.com/reference/create-single-immediate-payment

https://docs.acquired.com/docs/build-your-own-ui-1



18. Transactions - Retrieve a transaction

GET {{url}}transactions/:transaction_id

Retrieves a transaction using the unique transaction_id. This identifier can be found in the response after submitting a payment.

https://docs.acquired.com/reference/fetch-transaction-by-id



19. Transactions - Process a refund

POST {{url}}transactions/:transaction_id/refund

Process a refund for a specific payment. The refunded amount will by credited either via bank transfer or by refunding the amount onto your customer's card.

https://docs.acquired.com/reference/create-refund



20. Transactions - Process a void

POST {{url}}transactions/:transaction_id/void

Process a cancellation of a transaction before it settles through a consumer's account.

https://docs.acquired.com/reference/create-void



21. Transactions - Process a capture

POST {{url}}transactions/:transaction_id/capture

Process a capture of funds to settle the transaction.

https://docs.acquired.com/reference/create-capture



22. Transactions - Retrieve all transactions

GET {{url}}transactions



23. Faster Payments - Create a payee

POST {{url}}customers/:customer_id/payees

Create a new payee that will be stored against the customer profile.

https://docs.acquired.com/reference/create-payee



24. Faster Payments - Process a payout

POST {{url}}pay-out

Execute a payment to one of your customers.

https://docs.acquired.com/reference/create-payout



25. Faster Payments - Internal transfer

POST {{url}}/payments/internal-transfer

Process an internal transfer between accounts.

https://docs.acquired.com/reference/create-internal-transfer



26. Faster Payments - Retrieve account details

GET /accounts/:account_id

Retrieves the account details using the unique account_id.

https://docs.acquired.com/reference/fetch-account-by-id



27. Components - Generate a session_id

POST {{url}}payment-sessions

When using our Components solution, you are required to submit a request that includes payment details to create a session_id. This session_id will hold transaction-specific information and will be used to complete the payment. At a minimum you are required to submit the order_id, amount & currency.

We also recommend submitting your 3DS requirements at this stage.

https://docs.acquired.com/reference/create-session-id



28. Components - Update a session_id

PUT {{url}}payment-sessions/:session_id

This request allows you to update any details of the previously created session_id. Submit a request containing the parameters to be updated, when the payment is completed within Components. the authorisation request will use the latest parameters set against the session_id.

https://docs.acquired.com/reference/update-session-id



29. Direct Debit - Create a mandate

POST {{url}}:customer_id/mandates

Create a mandate associated to a customer_id.

If you are creating a mandate for a new customer, submit a request to the /customers endpoint first, and then append the returned customer_id to the url path. For existing customers, simply append the customer_id to your mandate request.

https://docs.acquired.com/reference/create-a-mandate



30. Direct Debit - Create a collection

POST {{url}}payments/collection

Create a Direct Debit collection against a mandate_id to collect payments from the customer's bank account.

Include the collection amount and the relating mandate_id in your request.

https://docs.acquired.com/reference/create-a-collection



31. Direct Debit - Cancel a mandate

POST mandates/:mandate_id/cancel

This API endpoint allows for the immediate cancellation of a mandate. Any custom data supplied to this endpoint will be linked to the resulting mandate cancellation event. 

https://docs.acquired.com/reference/create-a-mandate-cancellation



32. Direct Debit - Cancel a Direct Debit collection

POST {{url}}transactions/:transaction_id/cancel

Use this function to cancel a Direct Debit transaction if it hasn't been submitted to the banks. Any custom data supplied to this endpoint will be stored against the payment cancellation event. 

https://docs.acquired.com/reference/create-a-direct-debit-cancellation



33. Direct Debit - Process a retry

POST transactions/:transaction_id/retry

Acquired provides the option to retry Direct Debit transactions that have been declined, specifically in cases where the failure occurred due to insufficient funds.

https://docs.acquired.com/reference/create-a-retry



34. Direct Debit - Retrieve a mandate

GET {{url}}mandates/:mandate_id

Utilise this endpoint to retrieve information associated with a specific mandate. Just add the necessary mandate_id to your request, and we will return the relevant data.

https://docs.acquired.com/reference/fetch-mandate-by-id



ENDPOINTS