Sync Delivery

curl --request POST \
  --url https://api.uat.accessrc.org/api/Delivery/Sync \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "deliveryList": [
    {
      "providerDeliveryId": "e05b049a-a93a-4b04-af96-5824e0af6684",
      "deliveryId": null,
      "deliveryAmount": 150,
      "deliveryUnit": "EUR",
      "deliveryVoucherSerialNo": "",
      "deliveryReferenceNo": "66021926",
      "status": "DELIVERY_REVERTED",
      "providerStatus": "Refund"
    },
    {
      "providerDeliveryId": "8a2b16e7-f074-4433-8ef2-ac8d913249f0",
      "deliveryId": null,
      "deliveryAmount": 200,
      "deliveryUnit": "EUR",
      "deliveryVoucherSerialNo": "",
      "deliveryReferenceNo": "55423654",
      "status": "DELIVERY_PENDING",
      "providerStatus": "Pending"
    }
  ]
}
'

{
  "error": null,
  "data": {
    "message": "Deliveries are synced successfully",
    "date": "2025-04-04T14:07:49Z"
  },
  "status": "success"
}

POST

api

Delivery

Sync

curl --request POST \
  --url https://api.uat.accessrc.org/api/Delivery/Sync \
  --header 'Content-Type: application/json-patch+json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "deliveryList": [
    {
      "providerDeliveryId": "e05b049a-a93a-4b04-af96-5824e0af6684",
      "deliveryId": null,
      "deliveryAmount": 150,
      "deliveryUnit": "EUR",
      "deliveryVoucherSerialNo": "",
      "deliveryReferenceNo": "66021926",
      "status": "DELIVERY_REVERTED",
      "providerStatus": "Refund"
    },
    {
      "providerDeliveryId": "8a2b16e7-f074-4433-8ef2-ac8d913249f0",
      "deliveryId": null,
      "deliveryAmount": 200,
      "deliveryUnit": "EUR",
      "deliveryVoucherSerialNo": "",
      "deliveryReferenceNo": "55423654",
      "status": "DELIVERY_PENDING",
      "providerStatus": "Pending"
    }
  ]
}
'

{
  "error": null,
  "data": {
    "message": "Deliveries are synced successfully",
    "date": "2025-04-04T14:07:49Z"
  },
  "status": "success"
}

Endpoint specification

This endpoint helps Service Provider to map AccessRC delivery with own delivery.
deliveryId is only required when providerDeliveryId and deliveryId aren’t mapped within /api/DeliveryRequest/Sync method. If they are already mapped this field can either be missing from the body, can be empty (“deliveryId:"""), or can be null (“deliveryId:null”)
DELIVERY_READY_TO_COLLECT -> Beneficiary can collect delivery or cash from a Cash pick-up location
DELIVERY_COLLECTED -> Beneficiary collected delivery or cash is delivered via iban
DELIVERY_PENDING -> Wait step which delivery provider ensures that delivery is collected
DELIVERY_REVERTED -> Delivery or cash is reverted
DELIVERED -> Delivery request is committed to the delivery provider

Authorizations

x-api-key

string

header

required

API Key required in x-api-key header

Body

deliveryList

object[]

required

Show child attributes

deliveryList.providerDeliveryId

string

required

Unique identifier (UUID) of the delivery record as provided by the external service provider. Used to link AccessRC deliveries with the provider’s system.

Maximum string length: 150

deliveryList.deliveryAmount

number<double>

required

The total quantity or value delivered to the beneficiary (e.g., cash amount, item count).

deliveryList.deliveryUnit

string

required

The measurement unit associated with the delivery amount (e.g., USD, EUR, PCS, KG).

Maximum string length: 64

deliveryList.status

enum<string>

required

Internal AccessRC status representing the delivery’s state in the system workflow (e.g., DELIVERY_REVERTED, DELIVERED, DELIVERY_COLLECTED, DELIVERY_PENDING).

Available options:

DRAFT,

SENT_TO_SERVICE_PROVIDER,

ACCEPTED_BY_SERVICE_PROVIDER,

REJECTED_BY_SERVICE_PROVIDER,

DELIVERY_PENDING,

DELIVERED,

DELIVERY_READY_TO_COLLECT,

DELIVERY_COLLECTED,

DELIVERY_REVERTED

Example:

"DRAFT"

deliveryList.deliveryId

string | null

Internal AccessRC delivery identifier. May be null if the record has not yet been fully linked or synchronized with AccessRC.

Maximum string length: 64

deliveryList.deliveryVoucherSerialNo

string | null

Unique serial number or voucher code issued for tracking or redemption purposes. Used to verify delivery authenticity.

Maximum string length: 64

deliveryList.deliveryReferenceNo

string | null

Optional external reference number for the delivery, typically provided by the service provider or financial system.

Maximum string length: 64

deliveryList.providerStatus

string | null

Current delivery status as reported by the external provider (e.g., Processing, Completed, Collected).

Maximum string length: 64

Response

Error

object

Show child attributes

Error.Code

integer<int32>

Error.Type

string

Error.Message

string

Error.Title

string

Data

object

Show child attributes

Data.Error

object

Show child attributes

Data.Error.Code

integer<int32>

Data.Error.Type

string

Data.Error.Message

string

Data.Error.Title

string

Data.Data

object

Show child attributes

Data.Data.error

object

Show child attributes

Data.Data.error.guid

string | null

Data.Data.error.code

integer<int32>

Data.Data.error.type

string | null

Data.Data.error.message

string | null

Data.Data.error.title

string | null

Data.Data.data

unknown

Data.Data.status

string | null

Data.Paging

object

Show child attributes

Data.Paging.Skip

integer<int32>

Data.Paging.Take

integer<int32>

Data.Paging.Total

integer<int32>

Data.Token

object

Sync Delivery Request Import Program with Applications

⌘I

Introduction

Endpoints

Events

Authorizations

Body

Response