Choose your integration profile

Answer these 5 questions about your integration to get a personalised checklist of the guides, endpoints and webhooks that apply to you. Nothing on this portal is hidden: every page stays reachable, matching pages are only marked "Relevant" or "Not needed".

Programme type

What type of programme do you run?

Mall programmeNon-mall programmeNot sure

Receipt scan

Can members add purchases by scanning receipts?

Receipt scan enabledNo receipt scanNot sure

Initial transactions

How are initial transactions for store setup sent?

Sent through the APIEntered in the Spaycial web appNot sure

Offers and rewards

Where are offers and rewards managed?

Managed in SpaycialManaged by your own systemNot sure

Store list

How is your store list kept up to date?

Synchronised through the APIManaged in the Spaycial platformNot sure

Guides

• Environments and access
• Quick start
• API keys and access tokens
• Access token validation endpoint
• Request signature
• RSA key generation
• Verifying webhook signatures
• Member subscription flow
• Authenticated action flow
• Webhooks lifecycle
• Onboarding your member
• Member activities page
• Add a claim
• Bank connections management

Endpoints

• List available opt-ins
• Register a member
• Add a first bank connection from a bank callback
• Get an access token
• Log in with phone and password
• Send the password confirmation email
• Send an SMS verification code
• Confirm an SMS verification code
• Verify a decoupled bank connection
• Register a member with a first receipt
• Get the current member
• Update the current member
• Delete the current member
• Change the member's password
• List the member's card-linked connections
• Add a credit card connection
• Delete a connection
• List all the member's connections
• List the member's bank connections
• Add a bank connection from a bank callback
• Update a bank connection's credentials
• Delete a bank connection
• Update a bank connection from a bank callback
• Track a member action
• Check that a member exists
• Check that a member is registered
• Check a referral
• Set the member's favourite account
• Get the member's favourite account
• Get the mobile wallet card link
• Send a favourite account link by SMS
• Send a bank credentials update link by SMS
• List the member's rewards
• List stores for the member
• List the member's transactions by store
• Get the member's points history
• List the member's transactions in a store
• List the member's transactions by service
• List the member's transactions for a service
• List the member's claims
• File a claim for a missing purchase
• List the member's receipts
• Upload a receipt
• Update a receipt
• List the member's opt-ins
• Update the member's opt-ins
• Update a member's bank connection
• List banks
• List webhooks
• Register a webhook
• Update a webhook
• Delete a webhook
• Get members' balances
• List offers
• Get an offer
• List transactions sent to your programme
• List the programme's stores
• Synchronise the store list
• Send an initial transaction
• List members registered in a period
• Delete a member
• Get recommended retailers for members
• Send a test customer transactions webhook
• Send a test bank connections update (v2) webhook

Webhooks

• customer_creation
• customer_subscription
• customer_transactions
• all_transactions
• receipt_updated
• bank_connections_update_v2
• bank_association_notification
• bank_status_update
• claim_update
• store_list_updated
• initial_transaction_update
• offer_updated
• reward_updated

Not needed for your integration (0)

Nothing here.