Cash Integration Process

Cash payments can be made easily by creating payment requests via the API. Users can then be guided to the returned redirect URLs, in which the Stitch-hosted UI advises them on to how to make their cash payments.

Generate Payment Request URL

Much like Pay By Bank, payment request creation is protected by a client token. You'll need to follow the steps described in the client token guide to obtain a client token with the client_paymentrequest scope. To create a payment initiation request, you'll need to ensure that the feature is enabled on your client.

To create the request, a GraphQL mutation is used to specify the requested amount, the references that will appear on the user and beneficiary's accounts, and the beneficiary details themselves.

The GraphQL API URL https://api.stitch.money/graphql can be used for all payment requests (whether on test or live clients).

Additional PaymentMethods

For now Cash is only available as an additional payment method to bank transfer on Pay By Bank. Payment Requests that are created with the Cash payment method will allow customers to choose cash in addition to bank transfer. Currently, we do not support Cash without Pay By Bank.

An example of a GraphQL request to create a payment initiation request with the Cash payment method is shown below:

The following table outlines the possible inputs for Cash:

Status	Description
enabled	Boolean field used to specify enable or disable Cash. Note that by default, this will be enabled.
mobileNumber	The mobile number of the user, used for OTP verification.
reference	Optional field for the reference that the user specifies when making their payment. Reference must contain 6 to 20 alphanumeric characters. By default, a unique reference is generated and returned on the response.

Cash Payment Method Details

Please note that:

The paymentMethods.cash type requires client configuration. Contact the technical team to assist in enabling your client for this feature.
For now, cash.atm is the only cash type that can be enabled.
Specifying a reference for the payment is supported but not recommended. Stitch will generate a unique reference for the payment if not provided.
Not setting the paymentMethods field results in an Pay By Bank request. This will still include the Cash payment method as set up on your client profile. To explicitly omit the payment method, provide the paymentMethods.cash.atm.enabled field with a value of false.
Due to the limitations of ATMs, the amount that can be received using the Cash at ATM payment method is restricted to denominations of 10. This is later specified on the response as amountRounded on CashAtmPaymentMethodDetails, and on transaction webhooks/queries as the amountReceived field on PaymentInitiationCashAtmPayer.
The payerInformation object is required to be populated, as this facilitates with handling risk and fraud measures around this payment method. More information on these particular fields can be found here.

Expiring payment requests

It is highly recommended that an expireAt Date (ISO 8601) is supplied in the creation of any payment initiation request. At the specified date and time, the payment request status will automatically move to PaymentInitiationRequestExpired, if the payment is not yet successfully completed.

Surface URL and Handle Callback

The URL returned by the API requires that a whitelisted redirect_uri is appended to it as a query string argument. If you direct a user to this URL, they will be guided through the process of completing the payment. For test clients, we do have the following URLs whitelisted by default:

@include "docs/partials/default_redirect_uris.md"

For example, if your whitelist URL configuration included the URL https://example.com/payment for payment requests, you'd append the following query string to the url returned from the API: ?redirect_uri=https%3A%2F%2Fexample.com%2Fpayment. The full URL you expose to the user should look like this

https://secure.stitch.money/connect/payment-request/2b068bd5-6a5a-42e1-8a45-673cb3ede612?
    redirect_uri=https%3A%2F%2Fexample.com%2Fpayment

Whitelisting Redirect URLs

@include "docs/partials/whitelist_uris.md"

Please note that production clients will not be allowed to use unsecure redirect_uri params such as http. For example

http://example.com/payment ❌

https://example.com/payment ✅

Once the user completes or cancels the payment request, they'll be redirected back to the redirect_uri. The below query string parameters will be passed back to the redirect_uri.

Request Field	Description	Type
id	The unique id of this payment request	ID
status	Status will have the value `complete` if the user successfully went through the UI and clicked 'I've paid', `closed` if the user clicked close in the UI, or `failed` if something went wrong while viewing the UI and payment instructions	String
externalReference	The value that was provided to the externalReference field when the payment initiation request was created. It can be used to correlate transaction IDs within your system with the payment request initiated by Stitch	String

The id can be used to retrieve the final payment request status and other details from the Stitch API, as well as relate to incoming webhooks.

danger

The status parameter does not directly relate to the user successfully finalizing the transaction, as they are required to make the actual payment with their bank separately from the Stitch UI.

To secure yourself from attackers who can send a fake payload to your redirect or webhook endpoint, and update the payment at the same time as funds are successfully received from the payer, we recommend:

using the webhooks as the source of truth as they are secure and will always be sent from Stitch.
making use of signed webhooks since you'll be able to verify the signature of each incoming webhook's request payload.

Using Multiple Internal Redirect URIs

For a situation where different callbacks lead to different internal URLs, you SHOULD have a single whitelisted redirect URL which can then have the logic handling the Stitch callback and redirect to the internal URLs. An overview of how to do this in NodeJS is as shown below:

const status = params.status;

switch (status) {
  case "complete":
    redirect("/eft-pending");
  case "closed":
  case "failed":
    redirect("/eft-retry");
  default:
    break;
}

As Cash is built upon the same integration as Pay By Bank, we subscribe to webhooks and receive updates in the same way:

Webhook Statuses

The payment webhook will be dispatched for each of the following status updates:

PaymentInitiationRequestCompleted
PaymentInitiationRequestCancelled
PaymentInitiationRequestExpired

Example Payload

{
  "data": {
    "client": {
      "paymentInitiationRequests": {
        "node": {
          "__typename": "PaymentInitiationRequest",
          "amount": {
            "currency": "ZAR",
            "quantity": "1"
          },
          "bankBeneficiaries": [
            {
              "__typename": "BankBeneficiary",
              "accountNumber": "1223273660",
              "bankAccountNumber": "1223273660",
              "bankId": "nedbank",
              "name": "FizzBuzz Co."
            }
          ],
          "beneficiaries": [
            {
              "__typename": "BankBeneficiary",
              "accountNumber": "1223273660",
              "bankAccountNumber": "1223273660",
              "bankId": "nedbank",
              "name": "FizzBuzz Co."
            }
          ],
          "beneficiaryReference": "KombuchaFizz",
          "cancellationReason": null,
          "created": "2022-10-11T09:52:13.312Z",
          "createdAt": "2022-10-11T09:52:13.312Z",
          "currency": "ZAR",
          "events": [],
          "externalReference": "79261d16-c53b-48eb-9019-dc9cfb6c5126",
          "failureReason": null,
          "id": "cGF5cmVxLzk2YjUyODU1LTBkMzQtNDI0MS04YmM2LWE4ODBlMDQ1ZGQzOQ==",
          "payerConstraints": null,
          "payerReference": "Joe-Fizz-01",
          "paymentConfirmation": {
            "__typename": "PaymentPending",
            "date": "2022-10-11T09:52:53.128Z"
          },
          "paymentMethods": [
            {
              "cash": {
                "atm": {
                  "enabled": true
                },
                "retailer": {
                  "barcodeNumber": "test-11132098754321",
                  "barcodeUrl": "https://test-barcode-url.com",
                  "enabled": true
                }
              }
            },
            {
              "eft": {
                "enabled": true
              }
            }
          ],
          "paymentRequestPayerConstraintRelationship": null,
          "quantity": "1",
          "refunds": [],
          "state": {
            "__typename": "PaymentInitiationRequestCompleted",
            "amount": {
              "currency": "ZAR",
              "quantity": 1
            },
            "beneficiary": {
              "__typename": "BankBeneficiary",
              "accountNumber": "1223273660",
              "bankAccountNumber": "1223273660",
              "bankId": "nedbank",
              "name": "FizzBuzz Co."
            },
            "date": "2022-10-11T09:52:53.114Z",
            "id": "96b52855-0d34-4241-8bc6-a880e045dd39",
            "payer": {
              "__typename": "PaymentInitiationBankAccountPayer",
              "accountName": "Current account",
              "accountNumber": "4104754941",
              "accountType": "current",
              "bankId": "absa"
            },
            "proofOfPayment": null
          },
          "updated": "2022-10-11T09:52:53.128Z",
          "updatedAt": "2022-10-11T09:52:53.128Z",
          "url": "https://secure-local.stitchmoney.com/connect/payment-request/96b52855-0d34-4241-8bc6-a880e045dd39",
          "userReference": "Joe-Fizz-01"
        }
      }
    }
  }
}

Retrieving Payment Request Status

The status of a Cash payment request works much like Pay By Bank.

To determine if and how a payment request was completed, we will need to retrieve its status.

Which payment method did the customer choose?

To determine which payment method was used to complete the payment request, look at the payer field on the PaymentInitiationRequestCompleted state.

The PaymentInitiationCashAtmPayer and PaymentInitiationCashTillPayer types indicate that the payment was completed using Cash.

Which payment method did the customer choose?

To determine which payment method was used to complete the payment request we will look at the payer field on the PaymentInitiationRequestCompleted state.

The PaymentInitiationBankAccountPayer field inidicates that the payment was completed using a bank transfer.
The PaymentInitiationCashAtmPayer or PaymentInitiationCashTillPayer field indicates that the payment was completed with cash at an ATM/branch or Till respectively.

Simulating Completed Payment Requests

When using your test client, you may simulate completion of a payment request, directly over the API. This replicates payment updates that would be made when a real cash payment is completed on a live client.

This is done by running the mutation shown below, containing the following input values:

The paymentRequestId of the pending payment request to be completed, and
The paymentMethod specified with the value cash_atm.

This results in the payment request moving to the final status PaymentInitiationRequestCompleted. A corresponding webhook notification will also be sent to your configured receiving endpoint.

Postman Collection

Cash requests can be created and tested using the Postman collection available here. These can be used by specifying your client credentials and supplying the custom request variables where required.

Generate Payment Request URL​

Expiring payment requests​

Surface URL and Handle Callback​

Using Multiple Internal Redirect URIs​

Subscribe to Webhooks​

Webhook Statuses​

Retrieving Payment Request Status​

Simulating Completed Payment Requests​

Postman Collection​