Add a new payment recipient
x-ms-visibility: "important"
Send a request to add a new payment recipient specified in the request body. A payment recipient can be connected to one or more sites or to the customer
application/json
Request Body required
Payment recipient object to be added
name string
contactEmail string
streetAddress string
city string
postalCode string
country string
accountNumber string
bankCode string
bankName string
businessId string
recipientType int32 nullable
Possible values: [0
, 1
]
Default value: 0
siteIds int64[]
language string
Responses
- 200
- 400
- 401
Returns the new payment recipient that was added successfully
application/json
Schema
Example (from schema)
Schema
id int64
name string
contactEmail string
streetAddress string
city string
postalCode string
country string
accountNumber string
bankCode string
bankName string
businessId string
recipientType int32 nullable
Possible values: [0
, 1
]
Default value: 0
created date-time
lastUpdated date-time
language string
{
"id": 0,
"name": "string",
"contactEmail": "string",
"streetAddress": "string",
"city": "string",
"postalCode": "string",
"country": "string",
"accountNumber": "string",
"bankCode": "string",
"bankName": "string",
"businessId": "string",
"recipientType": 0,
"created": "2024-10-10T06:49:37.375Z",
"lastUpdated": "2024-10-10T06:49:37.375Z",
"language": "string"
}
Errors in the body request
text/plain
Schema
Schema
string
Customer not found or not authorised
Loading...