Developer Center

This is a dynamic view of our Hypermedia API starting from the Entry Point.

Only relations starting with get- and create- are supported for now.

If you would rather see all available relations, please use the Reference.

• create-orders To create an order, the request entity must be a representation of the order to create. This order entity will likely include representations of the resources it is related to, in particular the order items. These related representations can themselves contain a representation of their own related resources. For example, an order to sign a mandate will contain a signMandate order item representation, which in turn contains a mandate representation. If the order is successful, final resources (such as a mandate, a signatory, a subscriber etc) will be created, in addition to the order resource itself, which is returned in the server’s response.  
• get-orders Retrieve the representation of specific order resource, using creditor reference and the order reference as parameters (both are mandatory).  
• create-mandates Create a legacy mandate. A legacy mandate is a paper mandate that you want to import in SlimPay without signing it.  
• get-mandates Get one mandate. Currently id or both creditorReference and reference (or rum) are mandatory.  
• create-payins Create a payment with a direction of IN (funds being paid from the customer to the merchant). It can be specified using a subscriber reference, a mandate reference (for a direct debit), or a card alias reference (for a card transaction). If a creditor entity is required, it can be passed within the creditor property. If the subscriber is specified for a direct debit, SlimPay will create the payment using the most recently signed mandate associated with this subscriber. If the mandate is specified, SlimPay will create the payment using the given mandate. If the subscriber is specified for a card transaction, SlimPay will create the payment using the latest card alias associated with this subscriber. If the card alias is specified, SlimPay will create the payment using the given card alias.  
• create-payouts Create a payment with a direction of OUT (funds being paid from the merchant to their customer). It can be specified using a subscriber reference or a mandate reference. If a creditor entity is required, it can be passed within the creditor property. If the subscriber is specified, SlimPay will create the payment using the most recently signed mandate associated with this subscriber. If the mandate is specified, SlimPay will create the payment using the given mandate.  
• create-recurrent-direct-debits Create a recurrent direct debit.  
• get-recurrent-direct-debits Retrieve the representation of a specific recurrent direct debit resource, using its id parameter.  
• create-documents Create a document.  
• get-documents Get one document. Both creditorReference and reference are mandatory.  
• get-card-aliases Get one card alias by id.  
• get-card-transaction-issues Get one card transaction issue.  
• get-creditors Retrieve the representation of a specific creditor resource, using its reference parameter.  
• create-document-template Creates a new document template in the database and its file in the files system.  
• create-mandate-template Creates a new mandate template in the database and its file in the files system.  
• create-recurrent-card-transactions Create a recurrent card transaction.  
• get-recurrent-card-transactions Retrieve the representation of a specific recurrent card transaction resource, using its id parameter.  
• create-webhook Create a webhook.  
• get-webhook Retrieve a specific webhook.  
• get-webhooks Retrieve all the webhook for a specific merchant.