PurplX - Transfers

The Transfers feature is for transferring funds from a local source to a PurplX user with the funds getting credited to a PurplX Wallet.

API Root URL (Sandbox)

Use the following base URL when making requests to the sandbox environment:

https://api.sandbox.purplx.me

Resources

Transfer

A Transfer object is an object that represents a local (non-cross border) transfer of funds.

Fields

Name	Type	Notes
`url`	URL	Read-only permanent address of the Transfer resource.
`id`	Integer	Read-only unique integer ID of the Transfer resource.
`type`	Enum	The type of transfer. Possible values are:

person-to-business
business-to-person
person-to-person | | partner_reference | String | Unique identifier for the Transfer from the Partner’s systems. | | sender | JSON Object | The Sender of the Transfer in JSON Object format. The only required field is name. E.g.: {”name”: “Marie El Khoury”}. | | receiver | JSON Object | The Receiver of the Transfer in JSON Object format. Required fields are first_name, last_name, and mobile_number. E.g.: { "first_name": "Elie", "last_name": "El Din", "mobile_number": "+96170123456" }. | | amount | JSON Object | The amount of the Transfer in JSON Object format. Required fields are (1) currency in ISO 4217 Code format, and value in Decimal format (number in String format). E.g.: { "currency": "USD", "value": "99.99" }. | | remarks | String | String describing the Transfer. Gets displayed to the Receiver. | | sender_receiver_relationship | Enum | | | purpose | Enum | | | status | Enum | | | status_history | JSON Array | A JSON Array of Objects | | extra_data | JSON Object | Arbitrary data attached to the Transfer. | | datetime_created | ISO 8601 Date and Time with UTC offset | The timestamp of when the Transfer was received and saved by PurplX. | | datetime_updated | ISO 8601 Date and Time with UTC offset | The timestamp of when the Transfer was last updated on PurplX. |

Endpoints

Create a Transfer from a Partner

POST /transfers/

Example payload

{
    "type": "person-to-person",
    "partner_reference": "2554393457",
    "sender": {
        "name": "Barack Obama"
    },
    "receiver": {
        "first_name": "Ahmad",
        "last_name": "Mohammad",
        "mobile_number": "+96170123456"
    },
    "amount": {
        "currency": "USD",
        "value": "367.41"
    },
    "remarks": "Payment for Invoice ABC1234",
    "sender_receiver_relationship": "Client or Service provider",
    "purpose": "Payment For Service"
}

List Transfers

GET /transfers/

Example response

{
	"count": 5,
	"previous": null,
	"next": " https://api.sandbox.purplx.me/transfers/?limit=1&offset=1",
	"results": [
		{
	    "url": " https://api.sandbox.purplx.me/transfers/40422/",
	    "id": 40422,
	    "type": "person-to-person",
	    "partner_reference": "2554393457",
	    "sender": {
	        "name": "Barack Obama"
	    },
	    "receiver": {
	        "first_name": "",
	        "last_name": "",
	        "mobile_number": "+96170123456"
	    },
	    "receiver": {
	        "app_user": {
	            "url": " https://api.sandbox.purplx.me/app-users/57878/",
	            "id": 57878,
	            "uuid": "47e6bef1-1203-4563-b0a5-a650ec5f1612",
	            "first_name_en": "Ahmad",
	            "last_name_en": "Mohammad"
	        },
	        "first_name": "Ahmad",
	        "mobile_number": "+96170123456",
	        "last_name": "Mohammad",
	    },
	    "amount": {
	        "currency": "USD",
	        "value": "367.41"
	    },
	    "remarks": "Payment for Invoice ABC1234",
	    "sender_receiver_relationship": "Client or Service provider",
	    "purpose": "Payment For Service",
	    "status": "created",
	    "status_history": [
	        {
	            "status": "created",
	            "datetime_updated": "2025-12-12T14:34:29.298304+00:00"
	        }
	    ],
	    "datetime_created": "2025-12-12T14:34:29.298558Z",
	    "datetime_updated": "2025-12-12T14:34:29.520364Z"
		}
	]
}

Retrieve a specific Transfer

GET /transfers/{id}/

Example response