Initiate a new money transfer by first creating a recipient. You may optionally supply a remittance hash to automatically build a remittance associated with this new recipient.

Generally, you want to reuse recipient records whenever you can, as this allows us to build a transaction history for a given person. However, there are plenty of instances when simply creating a new recipient record would be more appropriate, even when it pertains to the previously-created record and email address. (An example would be if the recipient is in a different province, which means that we would need to calculate a different service fee for him/her anyway.)

Supported Formats

json

Examples

{
  "recipient": {
    "id": 1,
    "user_id": 1,
    "first_name": "First",
    "middle_name": null,
    "last_name": "Last",
    "email": null,
    "mobile": "0917xxxxxxx",
    "address": null,
    "city": null,
    "province": null,
    "postal_code": null,
    "created_at": "2016-05-04T11:34:14.096+08:00",
    "updated_at": "2016-05-04T11:34:14.096+08:00",
    "deleted_at": null,
    "created_via_api": true,
    "deleted": false,
    "business_name": null,
    "business_slug": null,
    "is_test": false
  }
}

Params

Param name Description
recipient
required

Recipient Information

Validations:

  • Must be a Hash

recipient[first_name]
required

Validations:

  • Must be a String

recipient[last_name]
required

Validations:

  • Must be a String

recipient[mobile]
required

Validations:

  • Must be a String

recipient[email]
optional

Validations:

  • Must be a String

recipient[address]
optional

Validations:

  • Must be a String

recipient[city]
optional

Validations:

  • Must be a String

recipient[province]
optional

Validations:

  • Must be a String

recipient[postal_code]
optional

Validations:

  • Must be a String