Return a paginated list of matching customers.
/
Query Customer Delegates
April API (3.0)
Download OpenAPI description
Languages
Servers
Sandbox
https://api.sandbox.au.meetapril.io
Production
https://api.au.meetapril.io
These endpoints provide various methods for authenticating users from a backend service.
- POST /auth/signin Sign-in from a backend service on behalf of a consumer customer (B2C) or customer delegate (B2B)
Operations
A person or business purchasing goods or services from a merchant using Spenda to facilitate the payment. Customers are defined at the merchant level, so if an individual makes payments with multiple merchants, they will have a customer record for each of these merchants.
Spenda supports two broad categories of customers:
Consumer customers are individuals typically making purchases from the merchant via e-commerce websites. They are uniquely identified by emailAddress for a given merchant.
Organisation customers represent businesses wishing to make purchases from the merchant. They are uniquely identified by referenceCustomerId for a given merchant.
- GET /customers Return a paginated list of matching customers
- POST /customers Create a new customer or update the details of an existing customer
- GET /customers/{customerId} Return details of a customer
- POST /customers/kyc Perform a Know Your Customer (KYC) check on a consumer customer
- GET /customers/delegates Return a paginated list of matching customer delegates
- GET /customers/delegates/{customerDelegateId} Return details of a customer delegate
- PATCH /customers/delegates/{customerDelegateId} Various actions for updating a customer delegate such as linking to a new customer
- DELETE /customers/delegates/{customerDelegateId} Delete a customer delegate
Operations
- Sandboxhttps://api.sandbox.au.meetapril.io/customers
- Productionhttps://api.au.meetapril.io/customers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.sandbox.au.meetapril.io/customers?limit=0&page=0&sort=string&createdAfter=2019-08-24T14%3A15%3A22Z&createdBefore=2019-08-24T14%3A15%3A22Z&emailAddress=string&customerId=string&merchantId=string&name=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Matching items sorted as specified
Bodyapplication/jsonArray [
One of:
A reference provided by the merchant to identify this customer. If provided, must be unique for the given merchant.
Has the phone number and email address for this customer been verified to be correct.
When the customer was first added to the system.
Response
application/json
[ { "ConsumerCustomer": { … } } ]
Request
Create a new customer or update the details of an existing customer. For consumer customers, the email address and merchant identifier constitute the business key. For organisation customers, the customer reference id and the merchant identifier constitute the business key. If a record with the same business key already exists, then it is updated with the provided details, otherwise a new customer is added.
Security
Marketplace API Key | Merchant Secret Token
One of:
Consumer customers are individuals typically making purchases from the merchant via e-commerce websites. They are uniquely identified by emailAddress for a given merchant.
Phone number of the customer. Note, this must be in E164 format.
A reference provided by the merchant to identify this customer. Must be unique for the given merchant.
Has the phone number and email address for this customer been verified to be correct.
- Sandboxhttps://api.sandbox.au.meetapril.io/customers
- Productionhttps://api.au.meetapril.io/customers
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- UpsertConsumerCustomer
- UpsertMarketplaceCustomerProxy
- UpsertOrganisationCustomer
curl -i -X POST \
https://api.sandbox.au.meetapril.io/customers \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Merchant-Id: string' \
-d '{
"UpsertConsumerCustomer": {
"emailAddress": "lucy.diamond@star.com",
"phoneNumber": "+61401234567",
"referenceCustomerId": "CUST-48822821",
"givenName": "string",
"middleName": "string",
"familyName": "string",
"isVerified": true,
"metadata": {}
}
}'Response
application/json
{ "customerId": "cust_aZ-9UfKvllCPqGsa", "merchantId": "mcht_aZ-9UfKvllCPqGsZ" }
Security
Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT
- Sandboxhttps://api.sandbox.au.meetapril.io/customers/{customerId}
- Productionhttps://api.au.meetapril.io/customers/{customerId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.sandbox.au.meetapril.io/customers/{customerId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
- ConsumerCustomer
- OrganisationCustomer
{ "ConsumerCustomer": { "customerId": "cust_aZ-9UfKvllCPqGsa", "merchantId": "mcht_aZ-9UfKvllCPqGsZ", "marketplaceId": "mktp_aZ-9UfKvllCPqGsi", "referenceCustomerId": "CUST-48822821", "emailAddress": "lucy.diamond@star.com", "givenName": "string", "middleName": "string", "familyName": "string", "isVerified": true, "phoneNumber": "+61401234567", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } }
Request
Perform a Know Your Customer (KYC) check on a consumer customer. The response may indicate that more details are required in which case subsequent calls with the additional details can be made. See Know Your Customer for more details.
Alpha release - Consider this endpoint experimental and very likely to change in future.
Security
Marketplace API Key | Merchant Secret Token | Customer JWT
One of:
Identification information for the customer.
The customer's name
The customer's date of birth
The customer's address
Full form address, populated from the componentised version if an independent version of the string is not available
Componentised version of the customer address
KycConsumerCustomer.customerIdentification.driversLicenceobject(CustomerIdentificationDriversLicence)
The customer's drivers licence details (assumes Australia)
The customer's passport details (assumes Australia)
Whether the customer's email and phone number have already been verified by the merchant, for example via one-time-password or other 2FA means.
- Sandboxhttps://api.sandbox.au.meetapril.io/customers/kyc
- Productionhttps://api.au.meetapril.io/customers/kyc
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.sandbox.au.meetapril.io/customers/kyc \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Merchant-Id: string' \
-d '{
"KycConsumerCustomer": {
"emailAddress": "lucy.diamond@star.com",
"phoneNumber": "+61401234567",
"ipAddress": "string",
"customerIdentification": {
"name": {
"givenName": "string",
"middleName": "string",
"familyName": "string"
},
"dateOfBirth": "2019-08-24",
"address": {
"address": "string",
"componentised": {
"unitNumber": "string",
"streetNumber": "string",
"streetName": "string",
"streetType": "string",
"suburb": "string",
"city": "string",
"postcode": "string",
"state": "string",
"country": "string"
},
"addressIdentifier": "string"
},
"driversLicence": {
"number": "string",
"state": "string",
"documentNumber": "string"
},
"passport": {
"number": "string",
"country": "string"
},
"driversLicenceWithVersion": {
"number": "string",
"versionNumber": "string"
},
"passportWithExpiry": {
"number": "string",
"expiryDate": "string"
}
},
"isCustomerVerified": true,
"referenceCustomerId": "string"
}
}'Bodyapplication/json
One of:
Provides the KYC status information for the customer.
Response
application/json
- ConsumerCustomerKycResult
- OrganisationDelegateKycResult
{ "ConsumerCustomerKycResult": { "payTypeEligibility": { … } } }
Security
Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT
- Sandboxhttps://api.sandbox.au.meetapril.io/customers/delegates
- Productionhttps://api.au.meetapril.io/customers/delegates
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.sandbox.au.meetapril.io/customers/delegates?limit=0&page=0&sort=string&createdAfter=2019-08-24T14%3A15%3A22Z&createdBefore=2019-08-24T14%3A15%3A22Z&emailAddress=string&customerDelegateId=string&customerId=string&merchantId=string&name=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
[ { "customerDelegateId": "custd_aZ-9VPKvllCPqGs2", "delegateEmailAddress": "lucy.diamond@star.com", "delegatePhoneNumber": "+61401234567", "delegateName": "string", "linkedCustomers": [ … ], "customerAttributes": [ … ], "createdAt": "2019-08-24T14:15:22Z" } ]
Security
Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT
- Sandboxhttps://api.sandbox.au.meetapril.io/customers/delegates/{customerDelegateId}
- Productionhttps://api.au.meetapril.io/customers/delegates/{customerDelegateId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.sandbox.au.meetapril.io/customers/delegates/{customerDelegateId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "customerDelegateId": "custd_aZ-9VPKvllCPqGs2", "delegateEmailAddress": "lucy.diamond@star.com", "delegatePhoneNumber": "+61401234567", "delegateName": "string", "linkedCustomers": [ { … } ], "customerAttributes": [ { … } ], "createdAt": "2019-08-24T14:15:22Z" }
Security
Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT
- Sandboxhttps://api.sandbox.au.meetapril.io/customers/delegates/{customerDelegateId}
- Productionhttps://api.au.meetapril.io/customers/delegates/{customerDelegateId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api.sandbox.au.meetapril.io/customers/delegates/{customerDelegateId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Security
Marketplace API Key | Merchant Secret Token | Merchant JWT | Marketplace JWT | Admin JWT | Customer JWT
One of:
- LinkCustomerToDelegate
- UnlinkCustomerToDelegate
- UpdateDelegateEmailAddress
- UpdateDelegateLoanRole
- UpdateDelegateName
- UpdateDelegatePhoneNumber
- UpdateDelegatePosition
Link this customer delegate with the given merchant customer. Payment sources saved against a delegate will be available when signing in on behalf of any customers the delegate is linked to.
- Sandboxhttps://api.sandbox.au.meetapril.io/customers/delegates/{customerDelegateId}
- Productionhttps://api.au.meetapril.io/customers/delegates/{customerDelegateId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
- LinkCustomerToDelegate
- UnlinkCustomerToDelegate
- UpdateDelegateEmailAddress
- UpdateDelegateLoanRole
- UpdateDelegateName
- UpdateDelegatePhoneNumber
- UpdateDelegatePosition
curl -i -X PATCH \
'https://api.sandbox.au.meetapril.io/customers/delegates/{customerDelegateId}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"LinkCustomerToDelegate": {
"customerId": "cust_aZ-9UfKvllCPqGsa"
}
}'Response
application/json
{ "customerDelegateId": "custd_aZ-9VPKvllCPqGs2", "delegateEmailAddress": "lucy.diamond@star.com", "delegatePhoneNumber": "+61401234567", "delegateName": "string", "linkedCustomers": [ { … } ], "customerAttributes": [ { … } ], "createdAt": "2019-08-24T14:15:22Z" }
A business or individual that uses Spenda to facilitate payments for their customers.
- GET /merchants Return a paginated list of matching merchants
- POST /merchants Create a new sub-merchant within the context of a marketplace
- GET /merchants/{merchantId} Return details of a merchant
- PATCH /merchants/{merchantId} Various actions for updating a merchant such as updating the bank account used for payouts
- GET /merchants/{merchantId}/balances Query the account balances of a merchant
- POST /merchants/{merchantId}/files Upload a document scan as part of the merchant onboarding profile
- GET /merchants/{merchantId}/files/{fileId} Get details on a merchant onboarding file
- GET /merchants/{merchantId}/applepay Get the domains registered for ApplePay for the specified merchant
- GET /merchants/{merchantId}/owners Return details of all beneficial owners for the given merchant
- POST /merchants/{merchantId}/owners Create a beneficial owner for the given merchant
- GET /merchants/{merchantId}/owners/{ownerId} Return details of a beneficial owner
- PUT /merchants/{merchantId}/owners/{ownerId} Overwrite an existing beneficial owner
- DELETE /merchants/{merchantId}/owners/{ownerId} Delete a beneficial owner
- GET /merchants/industries List all industries we currently support
Operations
A payment source represents a reusable source of funds to use for payments.
- GET /sources/{sourceId}
- DELETE /sources/{sourceId}
- POST /sources Register a payment source that may be used to pay for one or more payments
- GET /sources Return a paginated list of matching payment sources
- GET /sources/blockedcards Return a paginated list of events related to cards that have been blocked
- PATCH /sources/blockedcards/{cardBlockId} Update actions on blocked cards
Operations
A payment token represents a single use reference to a source of funds that can be used to pay for an order.
- POST /tokens Generate a pay-in-full payment token based on the provided payment source
- GET /tokens/{paymentTokenId} Get the details for a pay-in-full payment token
- POST /tokens/{merchantId}/surchargequote Calculates the surcharged amounts for the specified payment type
Operations
A pay plan represents a payment where the Spenda platform has extended a loan to make a purchase that the customer pays back over one or more instalments.
- POST /payplans/offer Create a pay plan offer for a registered and KYC'd merchant customer
- GET /payplans Return a paginated list of matching pay plans
- POST /payplans Create a pay plan and payment token from a successful pay plan offer
- GET /payplans/{payPlanId} Return details of a pay plan
- POST /payplans/max Return the maximum loan amount the given customer is currently eligible for
- POST /payplans/parameters Calculate the pay plan parameters for the given amount and list of variants
Operations
An order captures the details of the goods or services that the customer is purchasing from the merchant.
- GET /orders Return a paginated list of matching orders
- POST /orders Creates a new order
- POST /orders/{orderId}/pay Pay for an order using a payment token
- GET /orders/{orderId} Retrieves an order
- DELETE /orders/{orderId} Cancels an order, invalidating it from being payable
- PATCH /orders/{orderId} Actions for modifying an existing order
Operations
Sandbox only endpoints for simulating external events such as a bank transfer.
- POST /simulation Sandbox only endpoint to simulate external events such as a bank transfer being performed
Operations
A transaction is a payment from the perspective of a merchant. The transaction shows how much the merchant will be paid, if they have been paid already and whether there have been any refunds.
- GET /transactions/{transactionId} Return details of a transaction
- GET /transactions Return a paginated list of matching transactions
- PATCH /transactions/{transactionId} Various actions for updating a transaction such as issuing a refund
- POST /transactions/payouts Request to create a manual payout for a merchant
- GET /transactions/payouts Return a paginated list of matching payout summaries
- GET /transactions/payouts/{payoutId} Return an aggregated breakdown of the money movements included in the payout along with details of the disbursement itself
- GET /transactions/invoices Return a paginated list of matching merchant invoices
- GET /transactions/invoices/{invoiceId} Return an aggregated breakdown of the money movements included in the invoice along with billing details
- GET /transactions/invoices/{invoiceId}/pdf Return a PDF of the merchant invoice intended to be sent to the payer merchant
- GET /transactions/settlement Return a paginated list of all settlement entries matching the given search criteria
- GET /transactions/settlement/report Return a list of all settlement entries matching the given search criteria
- GET /transactions/disputes Return a paginated list of all disputes matching the given search criteria
- GET /transactions/refunds Return a paginated list of matching refunds
Operations
A B2B2C setup where an entity with business customers (sub-merchants) uses Spenda to facilitate payments for their customers' customers.
- GET /marketplaces/{marketplaceId} Return details of a marketplace
- POST /marketplaces/customer Marketplace customers allow marketplaces to onboard their customers once and have them available over all their sub-merchants
Operations
Webhooks are a mechanism where merchants and marketplaces can register an endpoints against one or more events. When these events occur, a POST HTTP request is made to the registered endpoint with the event details.
- GET /webhooks Return a paginated list of matching webhook subscriptions
- POST /webhooks Create a new webhook subscription
- GET /webhooks/{id} Return details of a webhook subscription
- PATCH /webhooks/{id} Update an existing webhook subscription
Operations
Loans are payment products where credit is extended by a loan facility to a borrower. The borrower can be either an individual or a business depending on the loan product in question.
- GET /loans Return a paginated list of matching loan summaries
- GET /loans/statements/{loanStatementId} Return a loan statement summary
- GET /loans/statements Return a paginated list of matching loan statement summaries
- GET /loans/statements/entries Return a paginated list of matching loan statement entries
- GET /loans/enterprise/statements/{loanStatementId}/download Return a loan statement report in either CSV, PDF or XML format
- GET /loans/statements/entries/report Return a list of all loan statement entries matching the given search criteria
Operations
Endpoints related to the issuing of digital cards, typically associated with a trade account based loan.
- POST /issuer/card Administer digital card(s)
- GET /issuer/card Return a paginated list of matching digital card summaries
Operations