Skip to main content
POST
/
api
/
DeliveryChannel
/
Create
cURL
curl --request POST \
  --url https://api.uat.accessrc.org/api/DeliveryChannel/Create \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "providerDeliveryChannelId": "ced2396b-32b5-4b08-bd98-7830dfb2b622",
  "name": {
    "language": "EN",
    "translation": "Bulgaria Moneygram"
  },
  "shortDescription": {
    "language": "EN",
    "translation": "Collect your cash transfer at any MoneyGram agent location in Bulgaria using your valid identification and transaction reference number."
  },
  "landingPage": "www.moneygram.com",
  "contacts": [
    {
      "email": "[email protected]",
      "name": "John Doe",
      "phone": "+902129343472"
    }
  ],
  "callCenter": {
    "phone": "+18009269400",
    "email": "[email protected]",
    "website": "https://www.moneygram.com/mgo/ie/en/help/contact/",
    "whatsapp": "+905441112233"
  },
  "availability": {
    "categoriesSupported": [
      "CASH"
    ],
    "countriesSupported": [
      "BG",
      "HN",
      "ML",
      "PL"
    ],
    "countriesExcluded": [
      "UY"
    ],
    "kycSupported": [
      "ALL"
    ],
    "kycExcluded": [
      "OTHER"
    ],
    "currenciesSupported": [
      "USD",
      "GBP",
      "EUR"
    ],
    "currenciesExcluded": [
      "CHF"
    ],
    "nationalitiesSupported": [
      "BULGARIAN",
      "UKRAINIAN",
      "HUNGARIAN"
    ],
    "nationalitiesExcluded": [
      "FINNISH",
      "CROATIAN"
    ]
  },
  "budget": {
    "currency": "EUR",
    "commodity": null,
    "amount": 50000
  },
  "deliveryOptions": [
    {
      "fieldLabel": "IBAN (22 characters)",
      "fieldName": "accountNumber",
      "fieldMaxLength": 28,
      "fieldMinLength": 28,
      "dataType": "STRING",
      "defaultValue": "",
      "validationRegex": "^HN[0-9A-Za-z]*$",
      "isRequired": true
    }
  ],
  "status": null
}
'
{
  "error": null,
  "data": {
    "message": "Delivery Channel request is created successfully",
    "providerDeliveryChannelId": "ced2396b-32b5-4b08-bd98-7830dfb2b622",
    "date": "2025-04-04T14:07:49Z",
    "requestType": "Delivery Channel Create",
    "requestedDate": "2025-04-04T14:07:47Z"
  },
  "status": "success"
}

Authorizations

​
x-api-key
string
header
required

API Key required in x-api-key header

Body

​
providerDeliveryChannelId
string
required

Unique identifier (UUID) of the provider’s delivery channel. Used to reference this specific configuration in API operations.

Maximum string length: 64
​
name
object
required

Localized display name of the delivery channel, including the language code and translated text. (Note: this will be auto-translated to other languages whenever approved by AccessRC Admin)

​
landingPage
string
required

Public website URL of the provider or service where users can find more information.

Maximum string length: 512
​
availability
object
required

Specifies where and under which conditions the delivery channel is available — including supported and excluded categories, countries, KYC levels, currencies, and nationalities. Supported values will be filtered and matched within AccessRC to determine eligible delivery options, while excluded values will prevent beneficiaries from being assisted through this channel.

countriesSupported, countriesExcluded,kycSupported, kycExcluded, currenciesSupported, currenciesExcluded, nationalitiesSupported, nationalitiesExcluded can be absent in the request body, can be an empty array ("nationalitiesExcluded": []), or can be null ("nationalitiesExcluded": null)

​
shortDescription
object

Localized description providing key information about how the service or delivery channel can be accessed or used. (Note: this will be auto-translated to other languages whenever approved by AccessRC Admin). shortDescription can be absent in the request body, or can be null ("shortDescription": null)

​
contacts
object[] | null

List of primary contact persons for this delivery channel, including their name, email, and phone number.

contacts can be absent in the request body, can be an empty array ("contacts": []), or can be null ("contacts": null)

​
callCenter
object

Contact details for customer support, including phone number, email, website, and optional WhatsApp contact.

callCenter can be absent in the request body, or can be null ("callCenter": null)

phone, email, WhatsApp, website can be absent in the request body, can be null ("phone": null), or can be empty ("phone": "")

​
budget
object

Defines the allocated budget for this delivery channel, including currency, optional commodity type, and total amount. If a budget is provided, AccessRC won’t exceed this budget while sending the delivery requests. If the budget isn’t provided AccessRC will consider using the Program Virtual Budget that is defined while creating an assistance program in AccessRC

​
deliveryOptions
object[] | null

Array of input field definitions required for processing a delivery, including label, field name, data type, length constraints, default value, validation pattern, and requirement status. deliveryOptions can be absent in the request body, can be an empty array ("deliveryOptions": []), or can be null ("deliveryOptions": null)

​
status
enum<string> | null

Indicates the current operational status of the delivery channel (e.g., REQUESTED, OFFLINE, ONLINE). (Note: Create method overrides the value, and it is initially added as REQUESTED, so a new delivery channel can’t be created as Offline or Online) (Note: Update method can only update this field as Offline or Online)

Available options:
OFFLINE,
ONLINE,
REQUESTED

Response

OK

​
Error
object
​
Data
object