Create Recipients
Header Parameters
The matchmove issued user_id for which the request is being made
The IP using which the actor is making the request
The unique id of the device using which the actor is making the request
The user agent of the device using which the actor is making the request
The actor on behalf of whom the API request is being performed
Path Parameters
Unique identifier for your program, issued by MatchMove during onboarding. All requests must use the program_code assigned to your integration. Using a program_code that does not belong to your integration will result in an authorization error.
Body Parameters
Receiving institution type of payment associated with the beneficiary
BANKMOBILE_WALLETCASH_PICKUPCARDSType of beneficiary
INDIVIDUALBUSINESSCountry of beneficiary in ISO3166_alpha3 format
Currency of beneficiary payment in ISO 4217 format
It is group of object which would represent different attributes of individual beneficiary or business beneficiary. it would include
1. user information for individual user and business_information for business user.
2. address information.
3. bank information.
4. representative information for business user.
5. identification details.
6. Additional data requirement to capture relationship and purpose of transaction.
these...
Show child attributes
Response
OK
Response Attributes
ID of the recipient
Receiving institution type of payment associated with the recipient.
BANKMOBILE_WALLETCASH_PICKUPCARDSType of recipient
INDIVIDUALBUSINESSCountry of recipient represented in ISO 3166 format.
Currency of recipient currency represented in ISO 4217 format.
Status of the recipient
CREATEDPENDINGPENDING_REVIEWPENDING_ACTIVATIONACTIVEDELETEDFAILEDBLOCKEDUPDATE_REQUIREDINACTIVEID of the user who has created the recipient.
Created timestamp value of recipient
ID of the user who has updated the recipient.
Updated timestamp value of recipient
ID of the user who has deleted the recipient.
Deleted timestamp value of a recipient. it would only populated if recipient is deleted.
It respresents the reason of the activity
Represents the user object with id and type.
Show child attributes
Object to represent recipients bank details
Show child attributes
Object to represent recipient address details.
Show child attributes
Object to represent recipients basic details. this is required if recipient is type "INDIVIDUAL". If recipient type is BUSINESS, then we must be using business information
Show child attributes
this object is mandatory if the recipient is of type business. this object is not supported for recipient of type INDIVIDUAL.
Show child attributes
this is an optional object. this is supported when the recipient is of type BUSINESS. This object is not required if the the recipient is of type INDIVIDUAL.
Show child attributes
Represents the Identification details for individual recipient or business recipient.
Show child attributes
the additional data is required to process remittance. the values depend on the recipient's country.
Show child attributes
Created
Response Attributes
ID of the recipient
Receiving institution type of payment associated with the recipient.
BANKMOBILE_WALLETCASH_PICKUPCARDSType of recipient
INDIVIDUALBUSINESSCountry of recipient represented in ISO 3166 format.
Currency of recipient currency represented in ISO 4217 format.
Status of the recipient
CREATEDPENDINGPENDING_REVIEWPENDING_ACTIVATIONACTIVEDELETEDFAILEDBLOCKEDUPDATE_REQUIREDINACTIVEID of the user who has created the recipient.
Created timestamp value of recipient
ID of the user who has updated the recipient.
Updated timestamp value of recipient
ID of the user who has deleted the recipient.
Deleted timestamp value of a recipient. it would only populated if recipient is deleted.
It respresents the reason of the activity
Represents the user object with id and type.
Show child attributes
Object to represent recipients bank details
Show child attributes
Object to represent recipient address details.
Show child attributes
Object to represent recipients basic details. this is required if recipient is type "INDIVIDUAL". If recipient type is BUSINESS, then we must be using business information
Show child attributes
this object is mandatory if the recipient is of type business. this object is not supported for recipient of type INDIVIDUAL.
Show child attributes
this is an optional object. this is supported when the recipient is of type BUSINESS. This object is not required if the the recipient is of type INDIVIDUAL.
Show child attributes
Represents the Identification details for individual recipient or business recipient.
Show child attributes
the additional data is required to process remittance. the values depend on the recipient's country.
Show child attributes
Bad Request
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Unauthorized
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Forbidden
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Not Found
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Conflict - resource already exists or request conflicts with current state
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Internal Server Error
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Bad Gateway
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Service Unavailable
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API
Gateway Timeout
Response Attributes
Unique request ID for the API request
HTTP response code for the API request
MatchMove generated error code for the API request
MatchMove generated title for the error code
Details for the error code
Details for the error code
Optional object returned when a validation error encountered. The object returns details of the fields which failed validation errors and the respective reasons
Show child attributes
Timestamp for the processed API