Sign In
Sign Up

Receiver / Create

Create new receiver

Request Header Authorization
Authentication Yes

API Endpoint

{{ServerUrl}}api/v1/receiver/create
POST

API Parameters

Request Parameter

Field DataType Required Description
affiliateReceiverId string Yes affiliate receiver id
senderId bigint Yes sender id
firstName string Yes first name
lastName string Yes last name
address string Yes address
ampherId integer No ampher id from API Master Data
provinceId integer No province id from API Master Data
postcodeId integer No postcode id from API Master Data
countryCode string Yes country code (Alpha-3 code) from ISO 3166-1
phoneCountryCode string No phone country code
phoneNo string No phone no
dateOfBirth date No date of birth (ex. 1993-01-14T00:00:00)
email string No email
nationalityCode string Yes nationality code (Alpha-3 code) from ISO 3166-1
relationship string No relationship
isIndividual boolean Yes true=individual, false=corporation

Response Parameter

Field DataType Description
status string response status
message string response message
payload
id bigint receiver id

Sample JSON Request:

				
					{
    "affiliateReceiverId": "PHOENGSORN.ATTAVACHARA",
    "senderId": 1,
    "firstName": "PHOENGSORN",
    "lastName": "ATTAVACHARA ",
    "address": "17/20",
    "ampherId": 46,
    "provinceId": 3,
    "postcodeId": 11,
    "countryCode": "THA",
    "phoneCountryCode": "66",
    "phoneNo": "815981700",
    "dateOfBirth": "1990-01-29T00:00:00",
    "email": "josriket@gmail.com",
    "nationalityCode": "THA",
    "isIndividual": true
}

Response Codes and Statuses

Status Code Error Description
000 Success

Error Codes

Status Code Error Description
101 General/Process error (see message)
301 Permission denined
401 Unauthorized
500 Internal server error (see message)

Sample JSON Responses: Success

				
					{
    "status": "000",
    "message": "Success",
    "payload": {
        "id": 694
    }
}

Change Log