Spush¶

Simplifying Your Digital Finance

Set up Account Provider account¶

Step 1: Create Provider account¶

To create an account send connection request at the spush.co.uk → Open a free account or contact manager directly. Submit the required documents to verify your account and gain access.

Step 2: Get required credentials¶

Credentials that have to be issued:

spush__merchant_id → Merchant ID
spush__client_id → Client ID
spush__client_secret → Client Secret
spush__payment_key → Payment signature key
spush__webhook_key → Webhook signature key
spush__test_mode → Test Mode

Connect Provider Account¶

Step 1. Connect Provider account at the Corefy Dashboard¶

Press Connect at Spush Provider Overview page in 'New connection' section and choose Provider account option to open Connection form.

Connect

Enter credentials:

Merchant ID
Client ID
Client Secret
Payment signature key
Webhook signature key
Test Mode → true/false

Success

You have connected Spush Provider account!

API examples:¶

Minimum data set to create a payment invoices for spush_pay_eur_invoice service¶

PAYMENT

POST /api/commerce/payment-invoices HTTP/1.0
{
  "data":{
    "type":"payment-invoice",
    "attributes":{
      "service":"spush_pay_eur_invoice",
      "commerce_account":"Hello World",
      "currency":"EUR",
      "amount":10,
      "flow":"charge",
      "gateway_options":{
        "cardgate":{
          "tokenize":""
        }
      },
      "test_mode":true,
      "options":{
        "allow_partially":false,
        "bypass_hpp":false,
        "send_operation_context_on_return":false
      },
      "reference_id":"4f3da819-8fa4-41c2-b9fd-f922008a6b76",
      "service_fields":[
      ]
    }
  }
}

Minimum data set to create a payout invoices for spush_pay_eur service¶

PAYOUT

POST /api/commerce/payout-invoices HTTP/1.0
{
  "data":{
    "type":"payout-invoice",
    "attributes":{
      "service":"spush_pay_eur",
      "commerce_account":"Hello_world",
      "currency":"EUR",
      "amount":1.11,
      "test_mode":true,
      "reference_id":"3fe34db0-eb22-4443-9abb-8f759c3236da",
      "fields":{
        "account_number":"20197800410000000170"
      },
      "options":{
        "attempts_limit":0,
        "split_mode":false,
        "allow_partially":false,
        "auto_process":false
      }
    }
  }
}

Maximum data set to create a payout invoices for spush_pay_eur service¶

PAYOUT

POST /api/commerce/payout-invoices HTTP/1.0
{
  "data":{
    "type":"payout-invoice",
    "attributes":{
      "service":"spush_pay_eur",
      "commerce_account":"Hello_world",
      "currency":"EUR",
      "amount":1.13,
      "metadata":{
        "test":"123"
      },
      "customer":{
        "reference_id":"51d00709-290b-4d1c-adf6-cb1200e55a32",
        "name":"John Doe",
        "email":"[email protected]",
        "phone":"12312312312",
        "date_of_birth":"2000-09-06",
        "individual_tax_id":"123123123",
        "address":{
          "full_address":"adress",
          "country":"AW",
          "region":"region",
          "city":"London",
          "street":"street",
          "post_code":"123123123"
        }
      },
      "test_mode":true,
      "reference_id":"40d5b760-0be9-486c-8134-251df0cd6b0c",
      "fields":{
        "account_number":"20197800410000000170"
      },
      "options":{
        "attempts_limit":0,
        "split_mode":false,
        "allow_partially":false,
        "auto_process":false
      }
    }
  }
}

Provider Options¶

Provider_Options

session_lifetime
- lifetime of the invoice session
pass_return_urls
- allows the merchant to pass the customer's return URL
payment_purpose
- an option which merchant can specify an individual parameter key that we will use to find the value in the request metadata

Question

"Still looking for help connecting your Spush account?" Please contact our support team!