PayShap Payout

A PayShap ID is an alias for a bank account. The alias is a mobile number or a handle. PayShap works for ZAR only.

A merchant can use PayShap to pay a person who has a registered alias. The merchant does not need the account number.

How a merchant uses PayShap

• A merchant does not need a different integration. The existing bank account calls work.
• The account type stays bank_account. There is no new type. Do not add a payshap_id type.
• The bank code is PAYSHAP_ID.
• We return PAYSHAP_ID in the South Africa bank list. The merchant receives it from the get-banks call. The merchant does not need a separate lookup.
• To resolve an account, the merchant sends the bank code PAYSHAP_ID. The merchant puts the full PayShap ID in accountNumber. No other change is necessary.
• To make a payout, the merchant does the same. The bank code is the same. The full PayShap ID goes in accountNumber.
• The merchant must send the full PayShap ID. This includes the characters after the @.
• We do not restrict the format of the alias. The example below shows the usual shape.

Resolve an account

POST /core/accounts/resolve
{
  "currency": "ZAR",
  "bankCode": "PAYSHAP_ID",
  "accountNumber": "0713058274@nedbank"
}

{
  "success": true,
  "message": "Account resolve successful",
  "data": {
    "accountNumber": "0713058274@nedbank",
    "accountName": "Khanya Fresh Produce",
    "bankCode": "PAYSHAP_ID"
  }
}

In addition to the common details needed to process successful payments, the following fields are also required when sending money to a payshap Id in South Africa.

The payload should look like this:

{
  "sourceCurrency": "ZAR",
  "destinationCurrency": "ZAR",
  "amount": 10,
  "business": "{{Your Business ID}}",
  "description": "Payment",
  "customerReference": "54c80ef8928989",
  "beneficiary": {
    "firstName": "Customer",
    "lastName": "Name",
    "type": "individual",
    "accountHolderName": "Customer Name",
    "accountNumber": "0713058274@nedbank",
    "bankCode": "PAYSHAP_ID",
    "country": "ZA",
  },
  "paymentDestination": "bank_account"
}