With Payabli’s split funding functionality, you can use split instructions in the transaction request to distribute the funds from a single transaction to different bank accounts for a paypoint, or to different paypoints set up for split funding.

Setup

Contact the Payabli team to .

Contact the Payabli team to use this feature. The team will work with you to understand your business needs and design the best configuration.

Usage

To split funds, send split instructions in the paymentDetails object of a transaction request.

Build the request

Split funding is available in these endpoints:

Get required values

Split instructions support recipientEntryPoint, accountId, or both. This means that you can route funds to other paypoints, or to separate bank accounts of a single paypoint. This means that you can route funds to multiple accounts in other eligible paypoints, or to separate bank accounts of a the paypoint that’s processing the transaction.

1

Retrieve `recipientEntryPoint` values

Find the entrypoint value for the paypoints you want to send funds to. See Entrypoint Overview for instructions.

2

Retrieve `accountId` values

You can retrieve accountId values for all a Paypoint’s accounts by sending a GET request to the /Paypoint endpoint. They’re returned in objects in the Credentials array.

Split instructions

Send split instructions in the splitFunding array inside the paymentDetails object in the request. See Example request for help.

The amounts in the split instructions must add up to match the transaction net total exactly, or the request will fail.

splitFunding
array

An array of splitFundingContent objects.

Example request

Split a GetPaid transaction

curl --request POST \
     --url 'https://api-sandbox.payabli.com/api/MoneyIn/getpaid?forceCustomerCreation=false' \
     --header 'accept: application/json' \
     --header 'content-type: application/*+json' \
     --header 'requestToken: API TOKEN' \
     --data 
{
  "entryPoint": "41035afaa7",
  "accountId": "187-234",
  "paymentMethod": {
    "method": "card",
    "cardnumber": "4111111111111111",
    "cardexp": "12/25",
    "cardcvv": "999",
    "cardzip": "85284",
    "cardHolder": "Lisandra Olonets"
  },
"paymentDetails": {
  "totalAmount": 123.45,
  "serviceFee": 23.45,
  "splitFunding": [
    {
      "recipientEntryPoint": "41035afaa7",
      "accountId": "187-300", 
      "description": "Monthly maintenance fee",
      "amount": 50.45
    },
    {
      "recipientEntryPoint": "3005cdba0",
      "accountId": "230-391",
      "description": "Payment toward special assessment",  
      "amount": 30.33
    },
    {
      "recipientEntryPoint": "995d16ccba",
      "accountId": "298-239",
      "description": "Security deposit",
      "amount": 19.22
    }
  ]
},
  "customerData": {
    "customerId": "4440"
  }
}

Example response

The success response is the standard transaction success response.

Success response
{
    "responseText": "Success",
    "isSuccess": true,
    "pageIdentifier": null,
    "responseData": {
        "authCode": "TAS726",
        "referenceId": "245-d6af5e23b5db43fbbb2bea04614d2735",
        "resultCode": 1,
        "resultText": "Approved",
        "avsResponseText": null,
        "cvvResponseText": null,
        "customerId": 4440,
        "methodReferenceId": null
    }
}

Was this page helpful?