Get Marketplace

Authentication

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

Customers

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

Merchants

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

Payment sources

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

Payment tokens

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

Pay plans

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

Orders

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

Simulation

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

Transactions

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

Marketplaces

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

Get Marketplace

Request

Return details of a marketplace.

Security

Marketplace API Key | Admin JWT | Marketplace JWT

Path

marketplaceIdstringrequired

curl -i -X GET \
  'https://api.sandbox.au.meetapril.io/marketplaces/{marketplaceId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

One of:

marketplaceIdstringrequired

System unique identifier for a marketplace.

readableIdentifierstringrequired

Unique URL used for dashboards. Must be 4-255 characters, lowercase, alphanumeric without any special characters such as ! @ # & ( ) – [ ] : ; ‘, ? /.

businessNamestringrequired

Business name (as linked to ABN/ACN).

websitestringrequired

Company website.

companyEmailstringrequired

Company email address.

companyPhonestringrequired

Company phone number.

merchantDashboardAccessEnabledbooleanrequired

Indicates whether marketplace merchants are able to access the merchant dashboard.

marketplaceCustomerUsersEnabledbooleanrequired

Indicates whether the marketplace supports marketplace-level customers.

bankTransfersDetailsobject(BankTransfersDetails)

Bank account details to be used in bank transfer payments.

sourceRulesArray of objects(Rule)

The rules that configure payment sources for the marketplace. Rules include surcharging, platform fee (FUTURE), etc.

Response

application/json

{
  "marketplaceId": "mktp_aZ-9UfKvllCPqGsi",
  "readableIdentifier": "string",
  "businessName": "string",
  "website": "string",
  "companyEmail": "lucy.diamond@star.com",
  "companyPhone": "+61401234567",
  "merchantDashboardAccessEnabled": true,
  "marketplaceCustomerUsersEnabled": true,
  "bankTransfersDetails": {
    "bankAccountBsb": "string",
    "bankAccountNumber": "string",
    "payId": "string"
  },
  "sourceRules": [
    { … }
  ]
}

Upsert Marketplace Customer

Request

Marketplace customers allow marketplaces to onboard their customers once and have them available over all their sub-merchants. To set up payments for these payments, generate the merchant customer for the relevant sub-merchant using Upsert Customer

Security

Marketplace API Key | Marketplace JWT | Admin JWT

Headers

Marketplace-Idstring

Perform operation in the context of the given marketplace. Usually not required — specify only if acting on behalf of a marketplace not implied by the credentials specified in the Authorization header.

Bodyapplication/jsonrequired

One of:

UpsertConsumerMarketplaceCustomerobject(UpsertConsumerMarketplaceCustomer1)required

Consumer marketplace customers represent individuals who will be making purchases from one or more sub-merchants of the marketplace. They are uniquely identified by emailAddress for a given marketplace.

Alpha release - Consider this endpoint experimental and very likely to change in future.

UpsertConsumerMarketplaceCustomer.givenNamestringrequired

UpsertConsumerMarketplaceCustomer.middleNamestring

UpsertConsumerMarketplaceCustomer.familyNamestringrequired

UpsertConsumerMarketplaceCustomer.emailAddressstringrequired

Email address of the customer

UpsertConsumerMarketplaceCustomer.isVerifiedbooleanrequired

Has the phone number and email address for this customer been verified to be correct.

UpsertConsumerMarketplaceCustomer.phoneNumberstring

Phone number of the customer

UpsertConsumerMarketplaceCustomer.referenceCustomerIdstring

A reference provided by the merchant to identify this customer. Must be unique for the given merchant.

UpsertConsumerMarketplaceCustomer.metadataobject(JsonObject)

curl -i -X POST \
  https://api.sandbox.au.meetapril.io/marketplaces/customer \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Marketplace-Id: string' \
  -d '{
    "UpsertConsumerMarketplaceCustomer": {
      "givenName": "string",
      "middleName": "string",
      "familyName": "string",
      "emailAddress": "lucy.diamond@star.com",
      "isVerified": true,
      "phoneNumber": "+61401234567",
      "referenceCustomerId": "CUST-48822821",
      "metadata": {}
    }
  }'

Responses

Bodyapplication/json

One of:

ConsumerMarketplaceCustomerobject(ConsumerMarketplaceCustomer1)required

ConsumerMarketplaceCustomer.marketplaceCustomerIdstringrequired

ConsumerMarketplaceCustomer.marketplaceIdstringrequired

ConsumerMarketplaceCustomer.givenNamestring