> ## Documentation Index > Fetch the complete documentation index at: https://developer.accessrc.org/llms.txt > Use this file to discover all available pages before exploring further. # Create Delivery Channel ## OpenAPI ````yaml POST /api/DeliveryChannel/Create openapi: 3.0.4 info: title: ServiceProvider API version: v1 servers: [] security: - ApiKeyAuth: [] paths: /api/DeliveryChannel/Create: post: tags: - DeliveryChannel requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/DeliveryChannelRequestModal' example: 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: john_doe@moneygram.com name: John Doe phone: '+902129343472' callCenter: phone: '+18009269400' email: customerservice@moneygram.com 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 application/json: schema: $ref: '#/components/schemas/DeliveryChannelRequestModal' example: 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: john_doe@moneygram.com name: John Doe phone: '+902129343472' callCenter: phone: '+18009269400' email: customerservice@moneygram.com 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 text/json: schema: $ref: '#/components/schemas/DeliveryChannelRequestModal' example: 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: john_doe@moneygram.com name: John Doe phone: '+902129343472' callCenter: phone: '+18009269400' email: customerservice@moneygram.com 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 application/*+json: schema: $ref: '#/components/schemas/DeliveryChannelRequestModal' example: 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: john_doe@moneygram.com name: John Doe phone: '+902129343472' callCenter: phone: '+18009269400' email: customerservice@moneygram.com 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 responses: '200': description: OK content: application/json: schema: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: $ref: '#/components/schemas/BaseResponse' Paging: type: object properties: Skip: type: integer format: int32 Take: type: integer format: int32 Total: type: integer format: int32 Token: type: object example: 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 '400': description: Bad Request content: application/json: schema: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: $ref: '#/components/schemas/BaseResponse' Paging: type: object properties: Skip: type: integer format: int32 Take: type: integer format: int32 Total: type: integer format: int32 Token: type: object example: error: guid: 95bd740b-755b-4f95-8549-fa9acfc31a41 code: 400 type: ValidationError message: >- Invalid request body format. Please check your request format from AccessRC API specifications. title: Invalid Request Body data: null status: failed '401': description: Unauthorized content: application/json: schema: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: $ref: '#/components/schemas/BaseResponse' Paging: type: object properties: Skip: type: integer format: int32 Take: type: integer format: int32 Total: type: integer format: int32 Token: type: object example: error: guid: 2c77f4b6-6ff8-4017-8bb8-1d7a5c8e01f3 code: 401 type: Unauthorized message: null title: API Key is missing data: null status: failed '500': description: Internal Server Error content: application/json: schema: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: type: object properties: Error: type: object properties: Code: type: integer format: int32 Type: type: string Message: type: string Title: type: string Data: $ref: '#/components/schemas/BaseResponse' Paging: type: object properties: Skip: type: integer format: int32 Take: type: integer format: int32 Total: type: integer format: int32 Token: type: object example: error: guid: 2c77f4b6-6ff8-4017-8bb8-1d7a5c8e01f3 code: 500 type: Exception message: null title: Internal Server Error data: null status: failed components: schemas: DeliveryChannelRequestModal: required: - availability - landingPage - name - providerDeliveryChannelId type: object properties: providerDeliveryChannelId: maxLength: 64 minLength: 0 type: string description: >- Unique identifier (UUID) of the provider’s delivery channel. Used to reference this specific configuration in API operations. name: $ref: '#/components/schemas/DeliveryChannelTranslationForNameModal' shortDescription: $ref: >- #/components/schemas/DeliveryChannelTranslationForShortDescriptionModal landingPage: maxLength: 512 minLength: 0 type: string description: >- Public website URL of the provider or service where users can find more information. contacts: type: array items: $ref: '#/components/schemas/DeliveryChannelContactModal' description: >- 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) nullable: true callCenter: $ref: '#/components/schemas/DeliveryChannelCallCenterModal' availability: $ref: '#/components/schemas/DeliveryChannelAvailabilityModal' budget: $ref: '#/components/schemas/DeliveryChannelBudgetModal' deliveryOptions: type: array items: $ref: '#/components/schemas/DeliveryChannelDeliveryOptionModal' description: >- 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) nullable: true status: enum: - OFFLINE - ONLINE - REQUESTED type: string description: >- 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) nullable: true additionalProperties: false BaseResponse: type: object properties: error: $ref: '#/components/schemas/Error' data: nullable: true status: type: string nullable: true additionalProperties: false DeliveryChannelTranslationForNameModal: required: - language - translation type: object properties: language: enum: - 'NULL' - XX - EN - RU - UK - TR - AR - BG - CS - DA - DE - EL - ES - ET - FI - FR - HI - HR - HU - IT - KO - LT - LV - NL - PA - PL - PT - RO - SK - SL - SV - UR - AB - AA - AF - AK - SQ - AM - AN - HY - AS - AV - AE - AY - AZ - BM - BA - EU - BE - BN - BI - BS - BR - MY - CA - CH - CE - NY - ZH - CU - CV - KW - CO - CR - DV - DZ - EO - EE - FO - FJ - FY - FF - GD - GL - LG - KA - KL - GN - GU - HT - HA - HE - HZ - HO - IS - IO - IG - ID - IA - IE - IU - IK - GA - JA - JV - KN - KR - KS - KK - KM - KI - RW - KY - KV - KG - KJ - KU - LO - LA - LI - LN - LU - LB - MK - MG - MS - ML - MT - GV - MI - MR - MH - MN - NA - NV - ND - NR - NG - NE - 'NO' - NB - NN - II - OC - OJ - OR - OM - OS - PI - PS - FA - QU - RM - RN - SE - SM - SG - SA - SC - SR - SN - SD - SI - SO - ST - SU - SW - SS - TL - TY - TG - TA - TT - TE - TH - BO - TI - TO - TS - TN - TK - TW - UG - UZ - VE - VI - VO - WA - CY - WO - XH - YI - YO - ZA - ZU - CN type: string description: Localized display language of the delivery channel example: EN translation: maxLength: 1024 minLength: 0 type: string description: Localized display name of the delivery channel additionalProperties: false description: >- 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) DeliveryChannelTranslationForShortDescriptionModal: required: - language - translation type: object properties: language: enum: - 'NULL' - XX - EN - RU - UK - TR - AR - BG - CS - DA - DE - EL - ES - ET - FI - FR - HI - HR - HU - IT - KO - LT - LV - NL - PA - PL - PT - RO - SK - SL - SV - UR - AB - AA - AF - AK - SQ - AM - AN - HY - AS - AV - AE - AY - AZ - BM - BA - EU - BE - BN - BI - BS - BR - MY - CA - CH - CE - NY - ZH - CU - CV - KW - CO - CR - DV - DZ - EO - EE - FO - FJ - FY - FF - GD - GL - LG - KA - KL - GN - GU - HT - HA - HE - HZ - HO - IS - IO - IG - ID - IA - IE - IU - IK - GA - JA - JV - KN - KR - KS - KK - KM - KI - RW - KY - KV - KG - KJ - KU - LO - LA - LI - LN - LU - LB - MK - MG - MS - ML - MT - GV - MI - MR - MH - MN - NA - NV - ND - NR - NG - NE - 'NO' - NB - NN - II - OC - OJ - OR - OM - OS - PI - PS - FA - QU - RM - RN - SE - SM - SG - SA - SC - SR - SN - SD - SI - SO - ST - SU - SW - SS - TL - TY - TG - TA - TT - TE - TH - BO - TI - TO - TS - TN - TK - TW - UG - UZ - VE - VI - VO - WA - CY - WO - XH - YI - YO - ZA - ZU - CN type: string description: Localized description language of the delivery channel example: EN translation: maxLength: 1024 minLength: 0 type: string description: Localized description translated text of the delivery channel additionalProperties: false description: >- 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) DeliveryChannelContactModal: required: - email - name - phone type: object properties: email: maxLength: 256 minLength: 0 type: string name: maxLength: 128 minLength: 0 type: string phone: maxLength: 256 minLength: 0 type: string additionalProperties: false DeliveryChannelCallCenterModal: required: - phone type: object properties: phone: maxLength: 256 minLength: 0 type: string email: maxLength: 256 minLength: 0 type: string nullable: true website: maxLength: 512 minLength: 0 type: string nullable: true whatsapp: maxLength: 256 minLength: 0 type: string nullable: true additionalProperties: false description: >- 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": "") DeliveryChannelAvailabilityModal: required: - categoriesSupported type: object properties: categoriesSupported: type: array items: enum: - CASH - VOUCHERS - INFORMATION type: string example: CASH countriesSupported: type: array items: type: string nullable: true countriesExcluded: type: array items: type: string nullable: true kycSupported: type: array items: enum: - 'NULL' - NATIONAL_IDENTITY - PASSPORT - DRIVER_LICENSE - RESIDENCE - BIRTH_CERTIFICATE - OTHER - ALL - NOT_PROCESSED type: string example: 'NULL' nullable: true kycExcluded: type: array items: enum: - 'NULL' - NATIONAL_IDENTITY - PASSPORT - DRIVER_LICENSE - RESIDENCE - BIRTH_CERTIFICATE - OTHER - ALL - NOT_PROCESSED type: string example: 'NULL' nullable: true currenciesSupported: type: array items: enum: - 'NULL' - USD - EUR - GBP - JPY - AUD - CAD - CHF - RUB - BRL - BGN - COP - HUF - MDL - PLN - RON - UAH - TRY - PEN - ALL - AED - AFN - AMD - AOA - ARS - AWG - AZN - BAM - BBD - BDT - BHD - BIF - BMD - BND - BOB - BOV - BSD - BTN - BWP - BYN - BZD - CDF - CHE - CHW - CLF - CLP - CNY - COU - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - FJD - FKP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PGK - PHP - PKR - PYG - QAR - RSD - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TTD - TWD - TZS - UGX - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAD - XAF - XBA - XBB - XBC - XBD - XCD - XCG - XDR - XOF - XPF - XSU - XUA - YER - ZAR - ZMW - ZWG - ANG - HRK - SLL - VEF - ZWL type: string example: 'NULL' nullable: true currenciesExcluded: type: array items: enum: - 'NULL' - USD - EUR - GBP - JPY - AUD - CAD - CHF - RUB - BRL - BGN - COP - HUF - MDL - PLN - RON - UAH - TRY - PEN - ALL - AED - AFN - AMD - AOA - ARS - AWG - AZN - BAM - BBD - BDT - BHD - BIF - BMD - BND - BOB - BOV - BSD - BTN - BWP - BYN - BZD - CDF - CHE - CHW - CLF - CLP - CNY - COU - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - FJD - FKP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PGK - PHP - PKR - PYG - QAR - RSD - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TTD - TWD - TZS - UGX - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAD - XAF - XBA - XBB - XBC - XBD - XCD - XCG - XDR - XOF - XPF - XSU - XUA - YER - ZAR - ZMW - ZWG - ANG - HRK - SLL - VEF - ZWL type: string example: 'NULL' nullable: true nationalitiesSupported: type: array items: enum: - 'NULL' - NOT_ENOUGH_INFO - AFGHAN - ALANDER - ALBANIAN - ALGERIAN - AMERICAN - AMERICAN_SAMOAN - ANDORRAN - ANGOLAN - ANGUILLAN - ANTARCTICAN - ANTIGUANS - ARGENTINE - ARMENIAN - ARUBAN - AUSTRALIAN - AUSTRIAN - AZERBAIJANI - BAHAMIAN - BAHRAINI - BANGLADESHI - BARBADIAN - BARTHELEMOIS - BELARUSIAN - BELGIAN - BELIZEAN - BENINESE - BERMUDIAN - BHUTANESE - BOLIVIAN - BONAIRIAN - BOSNIAN - BOSNIAN_HERZEGOVINIAN - BOUVET_ISLANDER - BRAZILIAN - BRITISH - BRITISH_INDIAN_OCEAN_TERRITORY - BRITISH_VIRGIN_ISLANDER - BRUNEIAN - BULGARIAN - BURKINABE - BURMESE - BURUNDIAN - CAMBODIAN - CAMEROONIAN - CANADIAN - CAPE_VERDEAN - CAYMANIAN - CENTRAL_AFRICAN - CHADIAN - CHILEAN - CHINESE - CHRISTMAS_ISLANDER - COCOS_ISLANDER - COLOMBIAN - COMORAN - CONGOLESE - CONGOLESE_DR - COOK_ISLANDER - COSTA_RICAN - CROATIAN - CUBAN - CURACAOAN - CYPRIOT - CZECH - DANISH - DJIBOUTIAN - DOMINICAN - DOMINICAN_COMMONWEALTH - DUTCH - EAST_TIMORESE - ECUADOREAN - EGYPTIAN - EMIRATI - EQUATORIAL_GUINEAN - ERITREAN - ESTONIAN - ETHIOPIAN - FALKLAND_ISLANDER - FAROESE - FIJIAN - FILIPINO - FINNISH - FRENCH - FRENCH_GUIANESE - FRENCH_POLYNESIAN - FRENCH_SOUTHERN - GABONESE - GAMBIAN - GEORGIAN - GERMAN - GHANAIAN - GIBRALTAR - GREEK - GREENLANDER - GRENADIAN - GUADELOUPEAN - GUAMANIAN - GUATEMALAN - GUERNSEY - GUINEA_BISSAUAN - GUINEAN - GUYANESE - HAITIAN - HEARD_AND_MCDONALD_ISLANDER - HERZEGOVINIAN - HONDURAN - HONGKONGER - HUNGARIAN - I_KIRIBATI - ICELANDER - INDIAN - INDONESIAN - IRANIAN - IRAQI - IRISH - ISRAELI - ITALIAN - IVORIAN - JAMAICAN - JAPANESE - JERSEY - JORDANIAN - KAZAKHSTANI - KENYAN - KITTIAN_AND_NEVISIAN - KUWAITI - KYRGYZ - LAOTIAN - LATVIAN - LEBANESE - LIBERIAN - LIBYAN - LIECHTENSTEINER - LITHUANIAN - LUXEMBOURGER - MACANESE - MACEDONIAN - MAHORAIS - MALAGASY - MALAWIAN - MALAYSIAN - MALDIVIAN - MALIAN - MALTESE - MANX - MARSHALLESE - MARTINICAN - MAURITANIAN - MAURITIAN - MEXICAN - MICRONESIAN - MOLDOVAN - MONACAN - MONGOLIAN - MONTENEGRIN - MONTSERRATIAN - MOROCCAN - MOSOTHO - MOTSWANA - MOZAMBICAN - NAMIBIAN - NAURUAN - NEPALESE - NEW_CALEDONIAN - NEW_ZEALANDER - NI_VANUATU - NICARAGUAN - NIGERIAN - NIGERIEN - NIUEAN - NORFOLK_ISLANDER - NORTH_KOREAN - NORTHERN_IRISH - NORTHERN_MARIANA_ISLANDER - NORWEGIAN - OMANI - PAKISTANI - PALAUAN - PALESTINIAN - PANAMANIAN - PAPUA_NEW_GUINEAN - PARAGUAYAN - PERUVIAN - PITCAIRNER - POLISH - PORTUGUESE - PUERTO_RICAN - QATARI - REUNIONESE - ROMANIAN - RUSSIAN - RWANDAN - SAINT_HELENIAN - SAINT_LUCIAN - SAINT_MARTINER - SAINT_PIERRAIS - SALVADORAN - SAMOAN - SAN_MARINESE - SAO_TOMEAN - SAUDI - SCOTTISH - SENEGALESE - SERBIAN - SEYCHELLOIS - SIERRA_LEONEAN - SINGAPOREAN - SINT_MAARTENER - SLOVAKIAN - SLOVENIAN - SOLOMON_ISLANDER - SOMALI - SOUTH_AFRICAN - SOUTH_GEORGIA_AND_SOUTH_SANDWICH_ISLANDER - SOUTH_KOREAN - SOUTH_SUDANESE - SPANISH - SRI_LANKAN - SUDANESE - SURINAMER - SVALBARDIAN - SWAZI - SWEDISH - SWISS - SYRIAN - TAIWANESE - TAJIK - TANZANIAN - THAI - TOGOLESE - TOKELAUAN - TONGAN - TRINIDADIAN_OR_TOBAGONIAN - TUNISIAN - TURKISH - TURKMEN - TURKS_AND_CAICOS_ISLANDER - TUVALUAN - UGANDAN - UKRAINIAN - URUGUAYAN - US_MINOR_OUTLYING_ISLANDER - US_VIRGIN_ISLANDER - UZBEKISTANI - VATICAN - VENEZUELAN - VIETNAMESE - VINCENTIAN - WALLIS_AND_FUTUNA_ISLANDER - WELSH - WESTERN_SAHARAN - YEMENITE - ZAMBIAN - ZIMBABWEAN - ALL type: string example: NOT_ENOUGH_INFO nullable: true nationalitiesExcluded: type: array items: enum: - 'NULL' - NOT_ENOUGH_INFO - AFGHAN - ALANDER - ALBANIAN - ALGERIAN - AMERICAN - AMERICAN_SAMOAN - ANDORRAN - ANGOLAN - ANGUILLAN - ANTARCTICAN - ANTIGUANS - ARGENTINE - ARMENIAN - ARUBAN - AUSTRALIAN - AUSTRIAN - AZERBAIJANI - BAHAMIAN - BAHRAINI - BANGLADESHI - BARBADIAN - BARTHELEMOIS - BELARUSIAN - BELGIAN - BELIZEAN - BENINESE - BERMUDIAN - BHUTANESE - BOLIVIAN - BONAIRIAN - BOSNIAN - BOSNIAN_HERZEGOVINIAN - BOUVET_ISLANDER - BRAZILIAN - BRITISH - BRITISH_INDIAN_OCEAN_TERRITORY - BRITISH_VIRGIN_ISLANDER - BRUNEIAN - BULGARIAN - BURKINABE - BURMESE - BURUNDIAN - CAMBODIAN - CAMEROONIAN - CANADIAN - CAPE_VERDEAN - CAYMANIAN - CENTRAL_AFRICAN - CHADIAN - CHILEAN - CHINESE - CHRISTMAS_ISLANDER - COCOS_ISLANDER - COLOMBIAN - COMORAN - CONGOLESE - CONGOLESE_DR - COOK_ISLANDER - COSTA_RICAN - CROATIAN - CUBAN - CURACAOAN - CYPRIOT - CZECH - DANISH - DJIBOUTIAN - DOMINICAN - DOMINICAN_COMMONWEALTH - DUTCH - EAST_TIMORESE - ECUADOREAN - EGYPTIAN - EMIRATI - EQUATORIAL_GUINEAN - ERITREAN - ESTONIAN - ETHIOPIAN - FALKLAND_ISLANDER - FAROESE - FIJIAN - FILIPINO - FINNISH - FRENCH - FRENCH_GUIANESE - FRENCH_POLYNESIAN - FRENCH_SOUTHERN - GABONESE - GAMBIAN - GEORGIAN - GERMAN - GHANAIAN - GIBRALTAR - GREEK - GREENLANDER - GRENADIAN - GUADELOUPEAN - GUAMANIAN - GUATEMALAN - GUERNSEY - GUINEA_BISSAUAN - GUINEAN - GUYANESE - HAITIAN - HEARD_AND_MCDONALD_ISLANDER - HERZEGOVINIAN - HONDURAN - HONGKONGER - HUNGARIAN - I_KIRIBATI - ICELANDER - INDIAN - INDONESIAN - IRANIAN - IRAQI - IRISH - ISRAELI - ITALIAN - IVORIAN - JAMAICAN - JAPANESE - JERSEY - JORDANIAN - KAZAKHSTANI - KENYAN - KITTIAN_AND_NEVISIAN - KUWAITI - KYRGYZ - LAOTIAN - LATVIAN - LEBANESE - LIBERIAN - LIBYAN - LIECHTENSTEINER - LITHUANIAN - LUXEMBOURGER - MACANESE - MACEDONIAN - MAHORAIS - MALAGASY - MALAWIAN - MALAYSIAN - MALDIVIAN - MALIAN - MALTESE - MANX - MARSHALLESE - MARTINICAN - MAURITANIAN - MAURITIAN - MEXICAN - MICRONESIAN - MOLDOVAN - MONACAN - MONGOLIAN - MONTENEGRIN - MONTSERRATIAN - MOROCCAN - MOSOTHO - MOTSWANA - MOZAMBICAN - NAMIBIAN - NAURUAN - NEPALESE - NEW_CALEDONIAN - NEW_ZEALANDER - NI_VANUATU - NICARAGUAN - NIGERIAN - NIGERIEN - NIUEAN - NORFOLK_ISLANDER - NORTH_KOREAN - NORTHERN_IRISH - NORTHERN_MARIANA_ISLANDER - NORWEGIAN - OMANI - PAKISTANI - PALAUAN - PALESTINIAN - PANAMANIAN - PAPUA_NEW_GUINEAN - PARAGUAYAN - PERUVIAN - PITCAIRNER - POLISH - PORTUGUESE - PUERTO_RICAN - QATARI - REUNIONESE - ROMANIAN - RUSSIAN - RWANDAN - SAINT_HELENIAN - SAINT_LUCIAN - SAINT_MARTINER - SAINT_PIERRAIS - SALVADORAN - SAMOAN - SAN_MARINESE - SAO_TOMEAN - SAUDI - SCOTTISH - SENEGALESE - SERBIAN - SEYCHELLOIS - SIERRA_LEONEAN - SINGAPOREAN - SINT_MAARTENER - SLOVAKIAN - SLOVENIAN - SOLOMON_ISLANDER - SOMALI - SOUTH_AFRICAN - SOUTH_GEORGIA_AND_SOUTH_SANDWICH_ISLANDER - SOUTH_KOREAN - SOUTH_SUDANESE - SPANISH - SRI_LANKAN - SUDANESE - SURINAMER - SVALBARDIAN - SWAZI - SWEDISH - SWISS - SYRIAN - TAIWANESE - TAJIK - TANZANIAN - THAI - TOGOLESE - TOKELAUAN - TONGAN - TRINIDADIAN_OR_TOBAGONIAN - TUNISIAN - TURKISH - TURKMEN - TURKS_AND_CAICOS_ISLANDER - TUVALUAN - UGANDAN - UKRAINIAN - URUGUAYAN - US_MINOR_OUTLYING_ISLANDER - US_VIRGIN_ISLANDER - UZBEKISTANI - VATICAN - VENEZUELAN - VIETNAMESE - VINCENTIAN - WALLIS_AND_FUTUNA_ISLANDER - WELSH - WESTERN_SAHARAN - YEMENITE - ZAMBIAN - ZIMBABWEAN - ALL type: string example: NOT_ENOUGH_INFO nullable: true additionalProperties: false description: >- 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) DeliveryChannelBudgetModal: type: object properties: currency: enum: - 'NULL' - USD - EUR - GBP - JPY - AUD - CAD - CHF - RUB - BRL - BGN - COP - HUF - MDL - PLN - RON - UAH - TRY - PEN - ALL - AED - AFN - AMD - AOA - ARS - AWG - AZN - BAM - BBD - BDT - BHD - BIF - BMD - BND - BOB - BOV - BSD - BTN - BWP - BYN - BZD - CDF - CHE - CHW - CLF - CLP - CNY - COU - CRC - CUP - CVE - CZK - DJF - DKK - DOP - DZD - EGP - ERN - ETB - FJD - FKP - GEL - GHS - GIP - GMD - GNF - GTQ - GYD - HKD - HNL - HTG - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - KES - KGS - KHR - KMF - KPW - KRW - KWD - KYD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MGA - MKD - MMK - MNT - MOP - MRU - MUR - MVR - MWK - MXN - MXV - MYR - MZN - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PGK - PHP - PKR - PYG - QAR - RSD - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SHP - SLE - SOS - SRD - SSP - STN - SVC - SYP - SZL - THB - TJS - TMT - TND - TOP - TTD - TWD - TZS - UGX - USN - UYI - UYU - UYW - UZS - VED - VES - VND - VUV - WST - XAD - XAF - XBA - XBB - XBC - XBD - XCD - XCG - XDR - XOF - XPF - XSU - XUA - YER - ZAR - ZMW - ZWG - ANG - HRK - SLL - VEF - ZWL type: string nullable: true commodity: enum: - 'NULL' - BUNCH_COMMODITY - CAN_COMMODITY - CARTON_COMMODITY - CUP_COMMODITY - G_COMMODITY - GALLON_COMMODITY - KG_COMMODITY - LT_COMMODITY - METER_COMMODITY - PACK_COMMODITY - PCS_COMMODITY - SACK_COMMODITY - SESSION_COMMODITY - CLASS_COMMODITY - VISIT_COMMODITY - BAG_COMMODITY - BOTTLE_COMMODITY - BOX_COMMODITY - BUNDLE_COMMODITY - CANISTER_COMMODITY - CARD_COMMODITY - CASE_COMMODITY - CONTAINER_COMMODITY - DRUM_COMMODITY - ITEM_COMMODITY - JAR_COMMODITY - KIT_COMMODITY - PACKET_COMMODITY - PARCEL_COMMODITY - POUCH_COMMODITY - ROLL_COMMODITY - SACHET_COMMODITY - SET_COMMODITY - TICKET_COMMODITY - TUBE_COMMODITY - TRIP_COMMODITY - UNIT_COMMODITY - VOUCHER_COMMODITY type: string nullable: true amount: type: number format: double nullable: true additionalProperties: false description: >- 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 DeliveryChannelDeliveryOptionModal: required: - dataType - fieldLabel - fieldName - isRequired type: object properties: fieldLabel: maxLength: 128 minLength: 0 type: string description: >- The display label shown to users for this field (e.g., “IBAN (22 characters)”) and used for user-facing forms or validation messages. fieldName: maxLength: 128 minLength: 0 type: string description: >- The internal name or key used to identify the field in API requests (e.g., accountNumber). fieldMaxLength: type: integer description: >- The maximum number of characters or digits allowed for this field. Input exceeding this length won’t be allowed. If this value is sent as empty ““, the default value will be set as 500 format: int32 nullable: true fieldMinLength: type: integer description: >- The minimum number of characters or digits required for this field. Inputs shorter than this limit won’t be allowed. If this value is sent as empty ““, the default value will be set as 0 format: int32 nullable: true dataType: maxLength: 32 minLength: 0 type: string description: >- Defines the expected data type for the field (e.g., STRING, NUMBER, DATE). Determines how the input should be validated and processed. (Negligible field - will be updated) defaultValue: maxLength: 128 minLength: 0 type: string description: >- Specifies the default value pre-filled or assumed if the user does not provide input for this field. nullable: true validationRegex: maxLength: 128 minLength: 0 type: string description: >- Regular expression used to validate the field value against a specific format (e.g., IBAN pattern, phone number format). nullable: true isRequired: type: boolean description: >- Boolean value indicating whether this field is mandatory for successful submission or processing. additionalProperties: false Error: type: object properties: guid: type: string nullable: true code: type: integer format: int32 type: type: string nullable: true message: type: string nullable: true title: type: string nullable: true additionalProperties: false securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: API Key required in `x-api-key` header ````