Sync Delivery Request

curl --request POST \
  --url https://api.uat.accessrc.org/api/DeliveryRequest/Sync \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "deliveryRequestId": "2372dd86-1e5d-4110-97ba-ff3c4237a74f",
  "providerDeliveryRequestId": "4d6c8838-dce2-473f-a6e1-6f91c0ebc87c",
  "providerDelivery": [
    {
      "providerDeliveryId": "e05b049a-a93a-4b04-af96-5824e0af6684",
      "deliveryId": "6fd1ca79-1a5d-4bd9-a4c9-b41c48ff6b7a",
      "syncStatus": "SUCCESS",
      "comment": "",
      "providerStatus": "Completed"
    }
  ],
  "message": "Delivery Request successfully created",
  "providerStatus": "WaitingSecondaryLevelTopUpApproval",
  "status": "PENDING_APPROVAL"
}
'

{
  "error": null,
  "data": {
    "message": "Delivery Request is synced successfully",
    "providerDeliveryRequestId": "ced2396b-32b5-4b08-bd98-7830dfb2b622",
    "date": "2025-04-04T14:07:49Z"
  },
  "status": "success"
}

{
  "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"
}

{
  "error": {
    "guid": "2c77f4b6-6ff8-4017-8bb8-1d7a5c8e01f3",
    "code": 401,
    "type": "Unauthorized",
    "message": null,
    "title": "API Key is missing"
  },
  "data": null,
  "status": "failed"
}

{
  "error": {
    "guid": "2c77f4b6-6ff8-4017-8bb8-1d7a5c8e01f3",
    "code": 500,
    "type": "Exception",
    "message": null,
    "title": "Internal Server Error"
  },
  "data": null,
  "status": "failed"
}

POST

api

DeliveryRequest

Sync

curl --request POST \
  --url https://api.uat.accessrc.org/api/DeliveryRequest/Sync \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "deliveryRequestId": "2372dd86-1e5d-4110-97ba-ff3c4237a74f",
  "providerDeliveryRequestId": "4d6c8838-dce2-473f-a6e1-6f91c0ebc87c",
  "providerDelivery": [
    {
      "providerDeliveryId": "e05b049a-a93a-4b04-af96-5824e0af6684",
      "deliveryId": "6fd1ca79-1a5d-4bd9-a4c9-b41c48ff6b7a",
      "syncStatus": "SUCCESS",
      "comment": "",
      "providerStatus": "Completed"
    }
  ],
  "message": "Delivery Request successfully created",
  "providerStatus": "WaitingSecondaryLevelTopUpApproval",
  "status": "PENDING_APPROVAL"
}
'

{
  "error": null,
  "data": {
    "message": "Delivery Request is synced successfully",
    "providerDeliveryRequestId": "ced2396b-32b5-4b08-bd98-7830dfb2b622",
    "date": "2025-04-04T14:07:49Z"
  },
  "status": "success"
}

{
  "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"
}

{
  "error": {
    "guid": "2c77f4b6-6ff8-4017-8bb8-1d7a5c8e01f3",
    "code": 401,
    "type": "Unauthorized",
    "message": null,
    "title": "API Key is missing"
  },
  "data": null,
  "status": "failed"
}

{
  "error": {
    "guid": "2c77f4b6-6ff8-4017-8bb8-1d7a5c8e01f3",
    "code": 500,
    "type": "Exception",
    "message": null,
    "title": "Internal Server Error"
  },
  "data": null,
  "status": "failed"
}

Endpoint specification

This endpoint helps Service Provider to map AccessRC delivery request with own delivery request.
deliveryRequestId is provided to Service Provider within the DELIVERY_REQUEST_SENT event callback body
At this step if Service Provider can’t create delivery records for each assistance item, providerDelivery list can be empty.
providerDeliveryRequestId is optional but recommended: when supplied, AccessRC stores it against the deliveryRequestId for cross-system status tracking and operational integrity. It may be omitted, empty, or null.

Status

PENDING_APPROVAL -> Delivery request is in an approval process
REJECTED -> Delivery request is rejected
APPROVED -> Delivery request is approved

Sync Status

SUCCESS -> Delivery request delivery is successfully synced to Service Provider
FAILED -> Delivery request delivery is failed to sync to Service Provider

Authorizations

x-api-key

string

header

required

API Key required in x-api-key header

Body

deliveryRequestId

string

required

Unique identifier (UUID) of the delivery request within AccessRC. Used to track and reference the specific delivery transaction initiated by the system.

Maximum string length: 64

message

string

required

A descriptive summary of the delivery request, typically used for logging, notifications, or administrative review (e.g., “Approve 146,515 UAH of payment to 27 beneficiaries…”).

Maximum string length: 1024

providerStatus

string

required

Aggregated status received from the external provider for the entire delivery request (e.g., Pending, Completed, Failed).

Maximum string length: 64

status

enum<string>

required

Internal AccessRC status of the delivery request, indicating its approval or workflow state (e.g., PENDING_APPROVAL, APPROVED, REJECTED).

Available options:

DRAFT,

SENT_TO_SERVICE_PROVIDER,

PENDING_APPROVAL,

APPROVED,

REJECTED,

DELIVERED,

FAILED,

DISPATCH_IN_PROGRESS,

FAILED_RESPONSE_UNKNOWN

Example:

"DRAFT"

providerDeliveryRequestId

string | null

Unique identifier (UUID) assigned by the external service provider for the same delivery request, enabling cross-system tracking and synchronization.

Maximum string length: 64

providerDelivery

object[] | null

Array containing detailed records of delivery transactions handled by the provider, including status and synchronization results. providerDelivery can be an empty array ("providerDelivery": []) if delivery records are planned to be synced with /api/Delivery/Sync method later on.

Show child attributes

Response

Error

object

Show child attributes

Data

object

Show child attributes

Introduction

Endpoints

Events

Planned Events (not yet available)

Sync Delivery Request

Authorizations

Body

Response